edge-caiasoft/src/main/resources/swagger.api/edge-caiasoft.yaml at master · folio-org/edge-caiasoft · 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
openapi: 3.0.0
info:
  title: Edge CasiaSoft API
  version: v1
servers:
  - url: /caiasoftService/
paths:
  /ItemBarcodes/{itemBarcode}/accessioned/{remoteStorageConfigurationId}:
    get:
      responses:
        '200':
          description: Success get accession item
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/accessionItem"
        '500':
          description: Internal server error
          content:
            text/plain:
              schema:
                type: string
                example: Internal server error
      operationId: getAccessionItem
      parameters:
        - $ref: "#/components/parameters/item-barcode"
        - $ref: "#/components/parameters/remote-storage-id"
        - $ref: "#/components/parameters/x-okapi-token"
        - $ref: "#/components/parameters/x-okapi-tenant"
  /RequestBarcodes/{itemBarcode}/reshelved/{remoteStorageConfigurationId}:
    post:
      responses:
        '201':
          description: ""
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/returnItemResponse"
        '400':
          description: Bad request
          content:
            text/plain:
              schema:
                type: string
                example: Bad request
        '500':
          description: Internal server error
          content:
            text/plain:
              schema:
                type: string
                example: Internal server error
      description: Perform item return
      operationId: returnItemByBarcode
      requestBody:
        content:
          text/plain:
            schema:
              type: string
        required: false
      parameters:
        - $ref: "#/components/parameters/item-barcode"
        - $ref: "#/components/parameters/remote-storage-id"
        - $ref: "#/components/parameters/x-okapi-token"
        - $ref: "#/components/parameters/x-okapi-tenant"
  /Requests/{requestId}/route/{remoteStorageConfigurationId}:
     post:
       responses:
         '200':
           description: Success check-in by requestId and remoteStorageConfigurationId
           content:
             text/plain:
               schema:
                 type: string
         '500':
           description: Internal server error
           content:
             text/plain:
               schema:
                 type: string
                 example: Internal server error
       operationId: checkInByHoldId
       parameters:
         - $ref: "#/components/parameters/request-id"
         - $ref: "#/components/parameters/remote-storage-id"
         - $ref: "#/components/parameters/x-okapi-token"
         - $ref: "#/components/parameters/x-okapi-tenant"
components:
  schemas:
    accessionItem:
      $ref: schemas/accessionItem.json
    accessionQueues:
      allOf:
        - type: object
          properties:
            accessions:
              type: array
              items:
                $ref: "#/components/schemas/accessionItem"
    checkInItem:
      $ref: schemas/checkInItem.json
    returnItemResponse:
      $ref: schemas/returnItemResponse.json
  parameters:
    item-barcode:
      name: itemBarcode
      in: path
      required: true
      schema:
        type: string
    remote-storage-id:
      name: remoteStorageConfigurationId
      in: path
      required: true
      schema:
        $ref: schemas/uuid.json
    request-id:
      name: requestId
      in: path
      required: true
      schema:
        type: string
    x-okapi-token:
      name: x-okapi-token
      in: header
      required: true
      schema:
        type: string
    x-okapi-tenant:
      name: x-okapi-tenant
      in: header
      required: true
      schema:
        type: string