View | Details | Raw Unified | Return to bug 30275
Collapse All | Expand All

(-)a/api/v1/swagger/definitions/renewal.yaml (-1 / +4 lines)
Lines 13-19 properties: Link Here
13
      - "null"
13
      - "null"
14
    description: "Interface from which the renewal took place (values can be: api, cron, commandline, intranet, opac and sip)"
14
    description: "Interface from which the renewal took place (values can be: api, cron, commandline, intranet, opac and sip)"
15
  renewer_id:
15
  renewer_id:
16
    $ref: ../x-primitives.yaml#/patron_id
16
    type:
17
      - integer
18
      - "null"
19
    description: internally assigned for the user that processed the renewal
17
  renewal_date:
20
  renewal_date:
18
    type: string
21
    type: string
19
    format: date-time
22
    format: date-time
(-)a/api/v1/swagger/definitions/renewals.yaml (-1 / +1 lines)
Lines 1-5 Link Here
1
---
1
---
2
type: array
2
type: array
3
items:
3
items:
4
  $ref: renewal.yaml
4
  $ref: "renewal.yaml"
5
additionalProperties: false
5
additionalProperties: false
(-)a/api/v1/swagger/paths/checkouts.yaml (-13 / +24 lines)
Lines 80-85 Link Here
80
          type: string
80
          type: string
81
          enum:
81
          enum:
82
            - issuer
82
            - issuer
83
            - renewals
83
        collectionFormat: csv
84
        collectionFormat: csv
84
    produces:
85
    produces:
85
      - application/json
86
      - application/json
Lines 160-193 Link Here
160
      - checkouts
161
      - checkouts
161
    summary: Renew a checkout
162
    summary: Renew a checkout
162
    parameters:
163
    parameters:
163
      - $ref: ../parameters.yaml#/checkout_id_pp
164
      - $ref: "../swagger.yaml#/parameters/checkout_id_pp"
164
      - $ref: ../parameters.yaml#/seen_pp
165
      - $ref: "../swagger.yaml#/parameters/seen_pp"
165
    produces:
166
    produces:
166
      - application/json
167
      - application/json
167
    responses:
168
    responses:
168
      "201":
169
      "201":
169
        description: Updated borrower's checkout
170
        description: Updated borrower's checkout
170
        schema:
171
        schema:
171
          $ref: ../definitions.yaml#/checkout
172
          $ref: "../swagger.yaml#/definitions/checkout"
172
      "403":
173
      "403":
173
        description: Cannot renew checkout
174
        description: Cannot renew checkout
174
        schema:
175
        schema:
175
          $ref: ../definitions.yaml#/error
176
          $ref: "../swagger.yaml#/definitions/error"
176
      "404":
177
      "404":
177
        description: Checkout not found
178
        description: Checkout not found
178
        schema:
179
        schema:
179
          $ref: ../definitions.yaml#/error
180
          $ref: "../swagger.yaml#/definitions/error"
180
      "500":
181
      "500":
181
        description: |
182
        description: |
182
          Internal server error. Possible `error_code` attribute values:
183
          Internal server error. Possible `error_code` attribute values:
183
184
184
          * `internal_server_error`
185
          * `internal_server_error`
185
        schema:
186
        schema:
186
          $ref: ../definitions.yaml#/error
187
          $ref: "../swagger.yaml#/definitions/error"
187
      "503":
188
      "503":
188
        description: Under maintenance
189
        description: Under maintenance
189
        schema:
190
        schema:
190
          $ref: ../definitions.yaml#/error
191
          $ref: "../swagger.yaml#/definitions/error"
191
    x-koha-authorization:
192
    x-koha-authorization:
192
      permissions:
193
      permissions:
193
        circulate: circulate_remaining_permissions
194
        circulate: circulate_remaining_permissions
Lines 198-230 Link Here
198
      - checkouts
199
      - checkouts
199
    summary: List renewals for a checkout
200
    summary: List renewals for a checkout
200
    parameters:
201
    parameters:
201
      - $ref: ../parameters.yaml#/checkout_id_pp
202
      - $ref: "../swagger.yaml#/parameters/checkout_id_pp"
203
      - name: x-koha-embed
204
        in: header
205
        required: false
206
        description: Embed list sent as a request header
207
        type: array
208
        items:
209
          type: string
210
          enum:
211
            - renewer
212
        collectionFormat: csv
202
    produces:
213
    produces:
203
      - application/json
214
      - application/json
204
    responses:
215
    responses:
205
      "200":
216
      "200":
206
        description: List of checkouts renewals
217
        description: List of checkouts renewals
207
        schema:
218
        schema:
208
          $ref: ../definitions.yaml#/renewals
219
          $ref: "../swagger.yaml#/definitions/renewals"
209
      "403":
220
      "403":
210
        description: Access forbidden
221
        description: Access forbidden
211
        schema:
222
        schema:
212
          $ref: ../definitions.yaml#/error
223
          $ref: "../swagger.yaml#/definitions/error"
213
      "404":
224
      "404":
214
        description: Checkout not found
225
        description: Checkout not found
215
        schema:
226
        schema:
216
          $ref: ../definitions.yaml#/error
227
          $ref: "../swagger.yaml#/definitions/error"
217
      "500":
228
      "500":
218
        description: |
229
        description: |
219
          Internal server error. Possible `error_code` attribute values:
230
          Internal server error. Possible `error_code` attribute values:
220
231
221
          * `internal_server_error`
232
          * `internal_server_error`
222
        schema:
233
        schema:
223
          $ref: ../definitions.yaml#/error
234
          $ref: "../swagger.yaml#/definitions/error"
224
      "503":
235
      "503":
225
        description: Under maintenance
236
        description: Under maintenance
226
        schema:
237
        schema:
227
          $ref: ../definitions.yaml#/error
238
          $ref: "../swagger.yaml#/definitions/error"
228
    x-koha-authorization:
239
    x-koha-authorization:
229
      permissions:
240
      permissions:
230
        circulate: circulate_remaining_permissions
241
        circulate: circulate_remaining_permissions
(-)a/api/v1/swagger/swagger.yaml (-1 / +6 lines)
Lines 54-59 definitions: Link Here
54
    $ref: ./definitions/patron_extended_attribute.yaml
54
    $ref: ./definitions/patron_extended_attribute.yaml
55
  quote:
55
  quote:
56
    $ref: ./definitions/quote.yaml
56
    $ref: ./definitions/quote.yaml
57
  renewal:
58
    $ref: ./definitions/renewal.yaml
59
  renewals:
60
    $ref: ./definitions/renewals.yaml
57
  return_claim:
61
  return_claim:
58
    $ref: ./definitions/return_claim.yaml
62
    $ref: ./definitions/return_claim.yaml
59
  smtp_server:
63
  smtp_server:
Lines 109-114 paths: Link Here
109
    $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}"
113
    $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}"
110
  "/checkouts/{checkout_id}/allows_renewal":
114
  "/checkouts/{checkout_id}/allows_renewal":
111
    $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1allows_renewal"
115
    $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1allows_renewal"
116
  "/checkouts/{checkout_id}/renewals":
117
    $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1renewals"
112
  "/checkouts/{checkout_id}/renewal":
118
  "/checkouts/{checkout_id}/renewal":
113
    $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1renewal"
119
    $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1renewal"
114
  /circulation-rules/kinds:
120
  /circulation-rules/kinds:
115
- 

Return to bug 30275