mod-tlr/src/main/resources/swagger.api/ecs-loans.yaml at master · folio-org/mod-tlr · 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
openapi: 3.0.0
info:
  title: ECS Loans API
  version: v1
tags:
  - name: ecsLoans
paths:
  /tlr/loans/check-out-by-barcode:
    post:
      operationId: checkOutByBarcode
      description: Checks item out by barcode
      tags:
        - ecsLoans
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/check-out-request"
        required: true
      responses:
        '200':
          $ref: "#/components/responses/checkOutResponse"
        '400':
          $ref: '#/components/responses/badRequestResponse'
        '422':
          $ref: '#/components/responses/unprocessableEntityResponse'
        '500':
          $ref: '#/components/responses/internalServerErrorResponse'
  /tlr/loans/declare-item-lost:
    post:
      operationId: declareItemLost
      description: Declare item lost
      tags:
        - ecsLoans
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/declareItemLostRequest"
        required: true
      responses:
        '204':
          description: Item successfully declared lost
        '400':
          $ref: '#/components/responses/badRequestResponse'
        '422':
          $ref: '#/components/responses/unprocessableEntityResponse'
        '500':
          $ref: '#/components/responses/internalServerErrorResponse'
  /tlr/loans/claim-item-returned:
    post:
      operationId: claimItemReturned
      description: Claim item returned
      tags:
        - ecsLoans
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/claimItemReturnedRequest"
        required: true
      responses:
        '204':
          description: Item successfully claimed returned
        '400':
          $ref: '#/components/responses/badRequestResponse'
        '404':
          $ref: '#/components/responses/notFoundResponse'
        '422':
          $ref: '#/components/responses/unprocessableEntityResponse'
        '500':
          $ref: '#/components/responses/internalServerErrorResponse'
  /tlr/loans/declare-claimed-returned-item-as-missing:
    post:
      operationId: declareClaimedReturnedItemAsMissing
      description: Declare claimed returned item as missing
      tags:
        - ecsLoans
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/declareClaimedReturnedItemAsMissingRequest"
        required: true
      responses:
        '204':
          description: Item successfully claimed missing
        '400':
          $ref: '#/components/responses/badRequestResponse'
        '404':
          $ref: '#/components/responses/notFoundResponse'
        '422':
          $ref: '#/components/responses/unprocessableEntityResponse'
        '500':
          $ref: '#/components/responses/internalServerErrorResponse'
components:
  schemas:
    check-out-request:
      $ref: 'schemas/circulation/check-out-request.yaml'
    check-out-dry-run-request:
      $ref: 'schemas/circulation/check-out-dry-run-request.yaml'
    check-out-dry-run-response:
      $ref: 'schemas/circulation/check-out-dry-run-response.yaml'
    loan-policy:
      $ref: 'schemas/circulation-storage/loan-policy.json'
    errorResponse:
      $ref: 'schemas/errors.json'
    consortiumItems:
      $ref: 'schemas/search/consortiumItems.yaml'
    searchBatchIds:
      $ref: 'schemas/search/batchIds.yaml'
    declareItemLostRequest:
      $ref: 'schemas/circulation/declare-item-lost-request.yaml'
    claimItemReturnedRequest:
      $ref: 'schemas/circulation/claim-item-returned-request.yaml'
    declareClaimedReturnedItemAsMissingRequest:
      $ref: 'schemas/circulation/declare-claimed-returned-item-as-missing-request.yaml'
  responses:
    checkOutResponse:
      description: Check out response
      content:
        application/json:
          schema:
            $ref: 'schemas/circulation/check-out-response.yaml'
    badRequestResponse:
      description: Validation errors
      content:
        application/json:
          example:
            errors:
              - message: Request is invalid
            total_records: 1
          schema:
            $ref: "#/components/schemas/errorResponse"
    notFoundResponse:
      description: Not found
      content:
        application/json:
          example:
            errors:
              - message: Request not found
            total_records: 1
          schema:
            $ref: "#/components/schemas/errorResponse"
    unprocessableEntityResponse:
      description: Validation errors
      content:
        application/json:
          example:
            errors:
              - message: Request is invalid
            total_records: 1
          schema:
            $ref: "#/components/schemas/errorResponse"
    internalServerErrorResponse:
      description: When unhandled exception occurred during code execution, e.g. NullPointerException
      content:
        application/json:
          example:
            errors:
              - message: Unexpected error
            total_records: 1
          schema:
            $ref: "#/components/schemas/errorResponse"