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 30-35 Link Here
30
          type: string
30
          type: string
31
          enum:
31
          enum:
32
            - issuer
32
            - issuer
33
            - renewals
33
        collectionFormat: csv
34
        collectionFormat: csv
34
    produces:
35
    produces:
35
      - application/json
36
      - application/json
Lines 156-189 Link Here
156
      - checkouts
157
      - checkouts
157
    summary: Renew a checkout
158
    summary: Renew a checkout
158
    parameters:
159
    parameters:
159
      - $ref: ../parameters.yaml#/checkout_id_pp
160
      - $ref: "../swagger.yaml#/parameters/checkout_id_pp"
160
      - $ref: ../parameters.yaml#/seen_pp
161
      - $ref: "../swagger.yaml#/parameters/seen_pp"
161
    produces:
162
    produces:
162
      - application/json
163
      - application/json
163
    responses:
164
    responses:
164
      "201":
165
      "201":
165
        description: Updated borrower's checkout
166
        description: Updated borrower's checkout
166
        schema:
167
        schema:
167
          $ref: ../definitions.yaml#/checkout
168
          $ref: "../swagger.yaml#/definitions/checkout"
168
      "403":
169
      "403":
169
        description: Cannot renew checkout
170
        description: Cannot renew checkout
170
        schema:
171
        schema:
171
          $ref: ../definitions.yaml#/error
172
          $ref: "../swagger.yaml#/definitions/error"
172
      "404":
173
      "404":
173
        description: Checkout not found
174
        description: Checkout not found
174
        schema:
175
        schema:
175
          $ref: ../definitions.yaml#/error
176
          $ref: "../swagger.yaml#/definitions/error"
176
      "500":
177
      "500":
177
        description: |
178
        description: |
178
          Internal server error. Possible `error_code` attribute values:
179
          Internal server error. Possible `error_code` attribute values:
179
180
180
          * `internal_server_error`
181
          * `internal_server_error`
181
        schema:
182
        schema:
182
          $ref: ../definitions.yaml#/error
183
          $ref: "../swagger.yaml#/definitions/error"
183
      "503":
184
      "503":
184
        description: Under maintenance
185
        description: Under maintenance
185
        schema:
186
        schema:
186
          $ref: ../definitions.yaml#/error
187
          $ref: "../swagger.yaml#/definitions/error"
187
    x-koha-authorization:
188
    x-koha-authorization:
188
      permissions:
189
      permissions:
189
        circulate: circulate_remaining_permissions
190
        circulate: circulate_remaining_permissions
Lines 194-226 Link Here
194
      - checkouts
195
      - checkouts
195
    summary: List renewals for a checkout
196
    summary: List renewals for a checkout
196
    parameters:
197
    parameters:
197
      - $ref: ../parameters.yaml#/checkout_id_pp
198
      - $ref: "../swagger.yaml#/parameters/checkout_id_pp"
199
      - name: x-koha-embed
200
        in: header
201
        required: false
202
        description: Embed list sent as a request header
203
        type: array
204
        items:
205
          type: string
206
          enum:
207
            - renewer
208
        collectionFormat: csv
198
    produces:
209
    produces:
199
      - application/json
210
      - application/json
200
    responses:
211
    responses:
201
      "200":
212
      "200":
202
        description: List of checkouts renewals
213
        description: List of checkouts renewals
203
        schema:
214
        schema:
204
          $ref: ../definitions.yaml#/renewals
215
          $ref: "../swagger.yaml#/definitions/renewals"
205
      "403":
216
      "403":
206
        description: Access forbidden
217
        description: Access forbidden
207
        schema:
218
        schema:
208
          $ref: ../definitions.yaml#/error
219
          $ref: "../swagger.yaml#/definitions/error"
209
      "404":
220
      "404":
210
        description: Checkout not found
221
        description: Checkout not found
211
        schema:
222
        schema:
212
          $ref: ../definitions.yaml#/error
223
          $ref: "../swagger.yaml#/definitions/error"
213
      "500":
224
      "500":
214
        description: |
225
        description: |
215
          Internal server error. Possible `error_code` attribute values:
226
          Internal server error. Possible `error_code` attribute values:
216
227
217
          * `internal_server_error`
228
          * `internal_server_error`
218
        schema:
229
        schema:
219
          $ref: ../definitions.yaml#/error
230
          $ref: "../swagger.yaml#/definitions/error"
220
      "503":
231
      "503":
221
        description: Under maintenance
232
        description: Under maintenance
222
        schema:
233
        schema:
223
          $ref: ../definitions.yaml#/error
234
          $ref: "../swagger.yaml#/definitions/error"
224
    x-koha-authorization:
235
    x-koha-authorization:
225
      permissions:
236
      permissions:
226
        circulate: circulate_remaining_permissions
237
        circulate: circulate_remaining_permissions
(-)a/api/v1/swagger/swagger.yaml (-1 / +6 lines)
Lines 56-61 definitions: Link Here
56
    $ref: ./definitions/patron_extended_attribute.yaml
56
    $ref: ./definitions/patron_extended_attribute.yaml
57
  quote:
57
  quote:
58
    $ref: ./definitions/quote.yaml
58
    $ref: ./definitions/quote.yaml
59
  renewal:
60
    $ref: ./definitions/renewal.yaml
61
  renewals:
62
    $ref: ./definitions/renewals.yaml
59
  return_claim:
63
  return_claim:
60
    $ref: ./definitions/return_claim.yaml
64
    $ref: ./definitions/return_claim.yaml
61
  smtp_server:
65
  smtp_server:
Lines 111-116 paths: Link Here
111
    $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}"
115
    $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}"
112
  "/checkouts/{checkout_id}/allows_renewal":
116
  "/checkouts/{checkout_id}/allows_renewal":
113
    $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1allows_renewal"
117
    $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1allows_renewal"
118
  "/checkouts/{checkout_id}/renewals":
119
    $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1renewals"
114
  "/checkouts/{checkout_id}/renewal":
120
  "/checkouts/{checkout_id}/renewal":
115
    $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1renewal"
121
    $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1renewal"
116
  /circulation-rules/kinds:
122
  /circulation-rules/kinds:
117
- 

Return to bug 30275