From a054b16f0bd822f6d028479a05bc3daa66b62877 Mon Sep 17 00:00:00 2001 From: Martin Renvoize Date: Tue, 26 Apr 2022 15:33:53 +0100 Subject: [PATCH] Bug 30275: (follow-up) Rebase fixes --- api/v1/swagger/definitions/renewal.yaml | 5 +++- api/v1/swagger/definitions/renewals.yaml | 2 +- api/v1/swagger/paths/checkouts.yaml | 37 +++++++++++++++--------- api/v1/swagger/swagger.yaml | 6 ++++ 4 files changed, 35 insertions(+), 15 deletions(-) diff --git a/api/v1/swagger/definitions/renewal.yaml b/api/v1/swagger/definitions/renewal.yaml index 97d50ea7f6..95e6d94816 100644 --- a/api/v1/swagger/definitions/renewal.yaml +++ b/api/v1/swagger/definitions/renewal.yaml @@ -13,7 +13,10 @@ properties: - "null" description: "Interface from which the renewal took place (values can be: api, cron, commandline, intranet, opac and sip)" renewer_id: - $ref: ../x-primitives.yaml#/patron_id + type: + - integer + - "null" + description: internally assigned for the user that processed the renewal renewal_date: type: string format: date-time diff --git a/api/v1/swagger/definitions/renewals.yaml b/api/v1/swagger/definitions/renewals.yaml index 5b2bff0270..3183b6e755 100644 --- a/api/v1/swagger/definitions/renewals.yaml +++ b/api/v1/swagger/definitions/renewals.yaml @@ -1,5 +1,5 @@ --- type: array items: - $ref: renewal.yaml + $ref: "renewal.yaml" additionalProperties: false diff --git a/api/v1/swagger/paths/checkouts.yaml b/api/v1/swagger/paths/checkouts.yaml index 80751e52ba..ebcb610c02 100644 --- a/api/v1/swagger/paths/checkouts.yaml +++ b/api/v1/swagger/paths/checkouts.yaml @@ -80,6 +80,7 @@ type: string enum: - issuer + - renewals collectionFormat: csv produces: - application/json @@ -160,34 +161,34 @@ - checkouts summary: Renew a checkout parameters: - - $ref: ../parameters.yaml#/checkout_id_pp - - $ref: ../parameters.yaml#/seen_pp + - $ref: "../swagger.yaml#/parameters/checkout_id_pp" + - $ref: "../swagger.yaml#/parameters/seen_pp" produces: - application/json responses: "201": description: Updated borrower's checkout schema: - $ref: ../definitions.yaml#/checkout + $ref: "../swagger.yaml#/definitions/checkout" "403": description: Cannot renew checkout schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Checkout not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: circulate: circulate_remaining_permissions @@ -198,33 +199,43 @@ - checkouts summary: List renewals for a checkout parameters: - - $ref: ../parameters.yaml#/checkout_id_pp + - $ref: "../swagger.yaml#/parameters/checkout_id_pp" + - name: x-koha-embed + in: header + required: false + description: Embed list sent as a request header + type: array + items: + type: string + enum: + - renewer + collectionFormat: csv produces: - application/json responses: "200": description: List of checkouts renewals schema: - $ref: ../definitions.yaml#/renewals + $ref: "../swagger.yaml#/definitions/renewals" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Checkout not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: circulate: circulate_remaining_permissions diff --git a/api/v1/swagger/swagger.yaml b/api/v1/swagger/swagger.yaml index 7ffd64d52a..a767438af4 100644 --- a/api/v1/swagger/swagger.yaml +++ b/api/v1/swagger/swagger.yaml @@ -54,6 +54,10 @@ definitions: $ref: ./definitions/patron_extended_attribute.yaml quote: $ref: ./definitions/quote.yaml + renewal: + $ref: ./definitions/renewal.yaml + renewals: + $ref: ./definitions/renewals.yaml return_claim: $ref: ./definitions/return_claim.yaml smtp_server: @@ -109,6 +113,8 @@ paths: $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}" "/checkouts/{checkout_id}/allows_renewal": $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1allows_renewal" + "/checkouts/{checkout_id}/renewals": + $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1renewals" "/checkouts/{checkout_id}/renewal": $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1renewal" /circulation-rules/kinds: -- 2.20.1