mod-consortia/src/main/resources/swagger.api/sharing_instances.yaml at master · folio-org/mod-consortia · 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
openapi: 3.0.0
info:
  title: Sharing instance and setting integration API
  description: "Sharing instance and setting integration API"
  version: 0.0.1
servers:
  - url: /consortia/{consortiumId}/sharing
paths:
  /instances:
    get:
      description: Sharing instances
      summary: Get list of sharing instances
      operationId: getSharingInstances
      parameters:
        - $ref: "#/components/parameters/consortiumId"
        - $ref: "#/components/parameters/instanceIdentifier"
        - $ref: "#/components/parameters/sourceTenantId"
        - $ref: "#/components/parameters/targetTenantId"
        - $ref: "#/components/parameters/status"
        - $ref: "#/components/parameters/trait_pageable_offset"
        - $ref: "#/components/parameters/trait_pageable_limit"
      responses:
        "200":
          $ref: "#/components/responses/SharingInstanceCollection"
        "400":
          $ref: "#/components/responses/BadRequest"
        "404":
          $ref: "#/components/responses/NotFound"
        "500":
          $ref: "#/components/responses/InternalServerError"
    post:
      summary: start instance sharing
      operationId: startSharingInstance
      parameters:
        - $ref: "#/components/parameters/consortiumId"
      requestBody:
        $ref: "#/components/requestBodies/SharingInstanceBody"
      responses:
        "201":
          $ref: "#/components/responses/SharingInstance"
        "400":
          $ref: "#/components/responses/BadRequest"
        "404":
          $ref: "#/components/responses/NotFound"
        "409":
          $ref: "#/components/responses/Conflict"
        "422":
          $ref: "#/components/responses/Conflict"
        "500":
          $ref: "#/components/responses/InternalServerError"
  /instances/{actionId}:
    get:
      summary: Get Sharing instance by action ID
      operationId: getSharingInstanceById
      parameters:
        - $ref: "#/components/parameters/consortiumId"
        - $ref: "#/components/parameters/actionId"
      responses:
        "200":
          $ref: "#/components/responses/SharingInstance"
        "400":
          $ref: "#/components/responses/BadRequest"
        "404":
          $ref: "#/components/responses/NotFound"
        "500":
          $ref: "#/components/responses/InternalServerError"
components:
  requestBodies:
    SharingInstanceBody:
      description: Sharing Instance object
      required: true
      content:
        application/json:
          schema:
            $ref: "schemas/sharingInstance.yaml#/SharingInstance"
  responses:
    SharingInstance:
      description: Returns a sharing instance object object
      content:
        application/json:
          schema:
            $ref: "schemas/sharingInstance.yaml#/SharingInstance"
    SharingInstanceCollection:
      description: Returns list of sharing instances
      content:
        application/json:
          schema:
            $ref: "schemas/sharingInstance.yaml#/SharingInstanceCollection"
    NoContent:
      description: No content
    Conflict:
      description: Validation errors
      content:
        application/json:
          schema:
            $ref: "schemas/common.yaml#/Errors"
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: "schemas/common.yaml#/Errors"
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: "schemas/common.yaml#/Errors"
    Unauthorized:
      description: Not authorized to perform requested action
      content:
        text/plain:
          example: unable to perform action -- unauthorized
    UnprocessableEntity:
      description: Validation errors
      content:
        application/json:
          schema:
            $ref: 'schemas/common.yaml#/Errors'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: "schemas/common.yaml#/Error"
  parameters:
    consortiumId:
      in: path
      name: consortiumId
      schema:
        $ref: "schemas/common.yaml#/uuid"
      required: true
      description: The ID of consortium
    actionId:
      in: path
      name: actionId
      schema:
        $ref: "schemas/common.yaml#/uuid"
      required: true
      description: The ID of sharing instance
    instanceIdentifier:
      in: query
      name: instanceIdentifier
      schema:
        $ref: "schemas/common.yaml#/uuid"
      description: The UUID of the instance
    sourceTenantId:
      in: query
      name: sourceTenantId
      schema:
        type: string
      description: The ID of the source tenant
    targetTenantId:
      in: query
      name: targetTenantId
      schema:
        type: string
      description: The ID of the target tenant
    status:
      in: query
      name: status
      schema:
        $ref: "schemas/status.yaml#/Status"
      description: The status of the sharing instance
    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: 100
        minimum: 0
        maximum: 2147483647
        type: integer