1 # ============LICENSE_START=======================================================
2 # Copyright (c) 2021 Bell Canada.
3 # Modifications Copyright (C) 2021-2022 Nordix Foundation
4 # Modifications Copyright (C) 2022 TechMahindra Ltd.
5 # ================================================================================
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
18 # SPDX-License-Identifier: Apache-2.0
19 # ============LICENSE_END=========================================================
23 description: Create a new dataspace
26 summary: Create a dataspace
27 operationId: createDataspace
29 - $ref: 'components.yml#/components/parameters/dataspaceNameInQuery'
32 $ref: 'components.yml#/components/responses/Created'
34 $ref: 'components.yml#/components/responses/BadRequest'
36 $ref: 'components.yml#/components/responses/Unauthorized'
38 $ref: 'components.yml#/components/responses/Forbidden'
40 $ref: 'components.yml#/components/responses/Conflict'
42 $ref: 'components.yml#/components/responses/InternalServerError'
44 description: Delete a dataspace
47 summary: Delete a dataspace
48 operationId: deleteDataspace
50 - $ref: 'components.yml#/components/parameters/dataspaceNameInQuery'
53 $ref: 'components.yml#/components/responses/NoContent'
55 $ref: 'components.yml#/components/responses/BadRequest'
57 $ref: 'components.yml#/components/responses/Unauthorized'
59 $ref: 'components.yml#/components/responses/Forbidden'
61 $ref: 'components.yml#/components/responses/Conflict'
63 $ref: 'components.yml#/components/responses/InternalServerError'
67 description: Create a new schema set in the given dataspace
70 summary: Create a schema set
71 operationId: createSchemaSet
73 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
74 - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
80 $ref: 'components.yml#/components/schemas/MultipartFile'
83 $ref: 'components.yml#/components/responses/Created'
85 $ref: 'components.yml#/components/responses/BadRequest'
87 $ref: 'components.yml#/components/responses/Unauthorized'
89 $ref: 'components.yml#/components/responses/Forbidden'
91 $ref: 'components.yml#/components/responses/Conflict'
93 $ref: 'components.yml#/components/responses/InternalServerError'
95 description: Read all schema sets, given a dataspace
98 summary: Get schema sets
99 operationId: getSchemaSets
101 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
110 $ref: 'components.yml#/components/schemas/SchemaSetDetails'
112 $ref: 'components.yml#/components/responses/BadRequest'
114 $ref: 'components.yml#/components/responses/Unauthorized'
116 $ref: 'components.yml#/components/responses/Forbidden'
118 $ref: 'components.yml#/components/responses/InternalServerError'
120 schemaSetBySchemaSetName:
122 description: Read a schema set given a schema set name and a dataspace
125 summary: Get a schema set
126 operationId: getSchemaSet
128 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
129 - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
136 $ref: 'components.yml#/components/schemas/SchemaSetDetails'
138 $ref: 'components.yml#/components/responses/BadRequest'
140 $ref: 'components.yml#/components/responses/Unauthorized'
142 $ref: 'components.yml#/components/responses/Forbidden'
144 $ref: 'components.yml#/components/responses/InternalServerError'
146 description: Delete a schema set given a schema set name and a dataspace
149 summary: Delete a schema set
150 operationId: deleteSchemaSet
152 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
153 - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
156 $ref: 'components.yml#/components/responses/NoContent'
158 $ref: 'components.yml#/components/responses/BadRequest'
160 $ref: 'components.yml#/components/responses/Unauthorized'
162 $ref: 'components.yml#/components/responses/Forbidden'
164 $ref: 'components.yml#/components/responses/Conflict'
166 $ref: 'components.yml#/components/responses/InternalServerError'
170 description: Read all anchors, given a dataspace
174 operationId: getAnchors
176 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
185 $ref: 'components.yml#/components/schemas/AnchorDetails'
187 $ref: 'components.yml#/components/responses/BadRequest'
189 $ref: 'components.yml#/components/responses/Unauthorized'
191 $ref: 'components.yml#/components/responses/Forbidden'
193 $ref: 'components.yml#/components/responses/InternalServerError'
195 description: Create a new anchor in the given dataspace
198 summary: Create an anchor
199 operationId: createAnchor
201 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
202 - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
203 - $ref: 'components.yml#/components/parameters/anchorNameInQuery'
206 $ref: 'components.yml#/components/responses/Created'
208 $ref: 'components.yml#/components/responses/BadRequest'
210 $ref: 'components.yml#/components/responses/Unauthorized'
212 $ref: 'components.yml#/components/responses/Forbidden'
214 $ref: 'components.yml#/components/responses/Conflict'
216 $ref: 'components.yml#/components/responses/InternalServerError'
218 anchorByDataspaceAndAnchorName:
220 description: Read an anchor given an anchor name and a dataspace
223 summary: Get an anchor
224 operationId: getAnchor
226 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
227 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
234 $ref: 'components.yml#/components/schemas/AnchorDetails'
236 $ref: 'components.yml#/components/responses/BadRequest'
238 $ref: 'components.yml#/components/responses/Unauthorized'
240 $ref: 'components.yml#/components/responses/Forbidden'
242 $ref: 'components.yml#/components/responses/InternalServerError'
244 description: Delete an anchor given an anchor name and a dataspace
247 summary: Delete an anchor
248 operationId: deleteAnchor
250 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
251 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
254 $ref: 'components.yml#/components/responses/NoContent'
256 $ref: 'components.yml#/components/responses/BadRequest'
258 $ref: 'components.yml#/components/responses/Unauthorized'
260 $ref: 'components.yml#/components/responses/Forbidden'
262 $ref: 'components.yml#/components/responses/InternalServerError'
266 description: Read all dataspaces
269 summary: Get all dataspaces
270 operationId: getAllDataspaces
279 $ref: 'components.yml#/components/schemas/DataspaceDetails'
281 $ref: 'components.yml#/components/responses/BadRequest'
283 $ref: 'components.yml#/components/responses/Unauthorized'
285 $ref: 'components.yml#/components/responses/Forbidden'
287 $ref: 'components.yml#/components/responses/InternalServerError'
291 description: Read a dataspace given a dataspace name
294 summary: Get a dataspace
295 operationId: getDataspace
297 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
304 $ref: 'components.yml#/components/schemas/DataspaceDetails'
306 $ref: 'components.yml#/components/responses/BadRequest'
308 $ref: 'components.yml#/components/responses/Unauthorized'
310 $ref: 'components.yml#/components/responses/Forbidden'
312 $ref: 'components.yml#/components/responses/InternalServerError'