Bug 28020: (follow-up) Add docs about error_code on the API
[koha.git] / api / v1 / swagger / paths / circulation-rules.yaml
1 ---
2 /circulation-rules/kinds:
3   get:
4     x-mojo-to: CirculationRules#get_kinds
5     operationId: getCirculationRuleKinds
6     tags:
7       - circulation_rules
8     summary: Get circulation rules kinds
9     produces:
10       - application/json
11     responses:
12       "200":
13         description: A map of rule kind information
14         schema:
15           type: object
16           additionalProperties:
17             $ref: ../definitions.yaml#/circ-rule-kind
18       "403":
19         description: Access forbidden
20         schema:
21           $ref: ../definitions.yaml#/error
22       "500":
23         description: |
24           Internal server error. Possible `error_code` attribute values:
25
26           * `internal_server_error`
27         schema:
28           $ref: ../definitions.yaml#/error
29       "503":
30         description: Under maintenance
31         schema:
32           $ref: ../definitions.yaml#/error