mod-circulation-item/src/main/resources/swagger.api/circulation-item.yaml at master · folio-org/mod-circulation-item · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
openapi: 3.0.0
info:
  title: Circulation item API
  version: v1
paths:
  /circulation-item:
    get:
      description: Return a list of items based on query
      operationId: getCirculationItemsByQuery
      parameters:
        - $ref: '#/components/parameters/cqlQueryCirculationItem'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
      responses:
        '200':
          description: Circulation Item created successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/circulationItems"
  /circulation-item/{circulationItemId}:
    post:
      description: Add new circulation item
      operationId: createCirculationItem
      requestBody:
        $ref: "#/components/requestBodies/CirculationItemBody"
      responses:
        '201':
          description: Circulation Item created successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/circulationItem"
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: "schemas/common.yaml#/Error"
        '422':
          $ref: "#/components/responses/trait_validate_422"
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: "schemas/common.yaml#/Error"
    get:
      description: Retrieve circulation item
      operationId: retrieveCirculationItemById
      responses:
        '200':
          description: Circulation Item retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/circulationItem"
        '404':
          description: Circulation Item not found
          content:
            application/json:
              schema:
                $ref: "schemas/common.yaml#/Error"
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: "schemas/common.yaml#/Error"
    put:
      responses:
        '200':
          description: Circulation Item updated successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/circulationItem"
        '400':
          description: Bad request
          content:
            text/plain:
              schema:
                type: string
                example: Bad request
        '404':
          description: Circulation Item not found
          content:
            text/plain:
              schema:
                type: string
                example: Circulation Item not found
        '500':
          description: Internal server error
          content:
            text/plain:
              schema:
                type: string
                example: Internal server error
      description: Change the circulation item
      operationId: updateCirculationItem
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/circulationItem"
        required: true
    parameters:
      - name: circulationItemId
        in: path
        required: true
        schema:
          $ref: "#/components/schemas/uuid"

components:
  responses:
    trait_validate_422:
      description: Validation errors
      content:
        application/json:
          example: examples/errors.sample
          schema:
            $ref: "#/components/schemas/errors"
    '400':
      description: Bad request
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/errors"
    '500':
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/errors"
  schemas:
    circulationItem:
      $ref: schemas/circulationItem.json
    circulationItems:
      allOf:
        - $ref: schemas/baseCollection.json
        - type: object
          properties:
            items:
              type: array
              items:
                $ref: "#/components/schemas/circulationItem"
          required:
            - items
    errors:
      $ref: schemas/errors.json
    uuid:
      $ref: schemas/uuid.json
  parameters:
    cqlQueryCirculationItem:
      name: query
      in: query
      schema:
        type: string
        default: cql.allRecords=1
      required: false
      description: A query expressed as a CQL string
    offset:
      name: offset
      in: query
      schema:
        type: integer
        default: 0
        minimum: 0
        maximum: 2147483647
      required: false
      description: Skip over a number of elements by specifying an offset value for the query
    limit:
      name: limit
      in: query
      schema:
        type: integer
        default: 1000
        minimum: 1
        maximum: 2147483647
      required: false
      description: Limit the number of elements returned in the response
    trait_queryable_query:
      name: query
      in: query
      description: A query string to filter rules based on matching criteria in fields.
      schema:
        type: string
    trait_pageable_offset:
      name: offset
      in: query
      description: Skip over a number of elements by specifying an offset value for the query
      schema:
        default: 0
        minimum: 0
        maximum: 2147483647
        type: integer
    trait_pageable_limit:
      name: limit
      in: query
      description: Limit the number of elements returned in the response
      schema:
        default: 10
        minimum: 0
        maximum: 2147483647
        type: integer
  requestBodies:
    CirculationItemBody:
          description: Circulation Item object
          required: true
          content:
            application/json:
              schema:
                $ref: "schemas/item.yaml#/CirculationItem"