1 # ============LICENSE_START=======================================================
2 # Copyright (c) 2021 Bell Canada.
3 # Modifications Copyright (C) 2021-2022 Nordix Foundation
4 # ================================================================================
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # SPDX-License-Identifier: Apache-2.0
18 # ============LICENSE_END=========================================================
22 description: Create a new dataspace
25 summary: Create a dataspace
26 operationId: createDataspace
28 - $ref: 'components.yml#/components/parameters/dataspaceNameInQuery'
31 $ref: 'components.yml#/components/responses/Created'
33 $ref: 'components.yml#/components/responses/Unauthorized'
35 $ref: 'components.yml#/components/responses/Forbidden'
37 $ref: 'components.yml#/components/responses/Conflict'
39 $ref: 'components.yml#/components/responses/InternalServerError'
41 description: Delete a dataspace
44 summary: Delete a dataspace
45 operationId: deleteDataspace
47 - $ref: 'components.yml#/components/parameters/dataspaceNameInQuery'
50 $ref: 'components.yml#/components/responses/NoContent'
52 $ref: 'components.yml#/components/responses/BadRequest'
54 $ref: 'components.yml#/components/responses/Unauthorized'
56 $ref: 'components.yml#/components/responses/Forbidden'
58 $ref: 'components.yml#/components/responses/Conflict'
60 $ref: 'components.yml#/components/responses/InternalServerError'
64 description: Create a new schema set in the given dataspace
67 summary: Create a schema set
68 operationId: createSchemaSet
70 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
71 - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
77 $ref: 'components.yml#/components/schemas/MultipartFile'
80 $ref: 'components.yml#/components/responses/Created'
82 $ref: 'components.yml#/components/responses/BadRequest'
84 $ref: 'components.yml#/components/responses/Unauthorized'
86 $ref: 'components.yml#/components/responses/Forbidden'
88 $ref: 'components.yml#/components/responses/Conflict'
90 $ref: 'components.yml#/components/responses/InternalServerError'
92 schemaSetBySchemaSetName:
94 description: Read a schema set given a schema set name and a dataspace
97 summary: Get a schema set
98 operationId: getSchemaSet
100 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
101 - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
108 $ref: 'components.yml#/components/schemas/SchemaSetDetails'
110 $ref: 'components.yml#/components/responses/BadRequest'
112 $ref: 'components.yml#/components/responses/Unauthorized'
114 $ref: 'components.yml#/components/responses/Forbidden'
116 $ref: 'components.yml#/components/responses/InternalServerError'
118 description: Delete a schema set given a schema set name and a dataspace
121 summary: Delete a schema set
122 operationId: deleteSchemaSet
124 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
125 - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
128 $ref: 'components.yml#/components/responses/NoContent'
130 $ref: 'components.yml#/components/responses/BadRequest'
132 $ref: 'components.yml#/components/responses/Unauthorized'
134 $ref: 'components.yml#/components/responses/Forbidden'
136 $ref: 'components.yml#/components/responses/Conflict'
138 $ref: 'components.yml#/components/responses/InternalServerError'
142 description: Read all anchors, given a dataspace
146 operationId: getAnchors
148 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
157 $ref: 'components.yml#/components/schemas/AnchorDetails'
159 $ref: 'components.yml#/components/responses/BadRequest'
161 $ref: 'components.yml#/components/responses/Unauthorized'
163 $ref: 'components.yml#/components/responses/Forbidden'
165 $ref: 'components.yml#/components/responses/InternalServerError'
167 description: Create a new anchor in the given dataspace
170 summary: Create an anchor
171 operationId: createAnchor
173 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
174 - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
175 - $ref: 'components.yml#/components/parameters/anchorNameInQuery'
178 $ref: 'components.yml#/components/responses/Created'
180 $ref: 'components.yml#/components/responses/BadRequest'
182 $ref: 'components.yml#/components/responses/Unauthorized'
184 $ref: 'components.yml#/components/responses/Forbidden'
186 $ref: 'components.yml#/components/responses/Conflict'
188 $ref: 'components.yml#/components/responses/InternalServerError'
190 anchorByDataspaceAndAnchorName:
192 description: Read an anchor given an anchor name and a dataspace
195 summary: Get an anchor
196 operationId: getAnchor
198 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
199 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
206 $ref: 'components.yml#/components/schemas/AnchorDetails'
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/InternalServerError'
216 description: Delete an anchor given an anchor name and a dataspace
219 summary: Delete an anchor
220 operationId: deleteAnchor
222 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
223 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
226 $ref: 'components.yml#/components/responses/NoContent'
228 $ref: 'components.yml#/components/responses/BadRequest'
230 $ref: 'components.yml#/components/responses/Unauthorized'
232 $ref: 'components.yml#/components/responses/Forbidden'
234 $ref: 'components.yml#/components/responses/InternalServerError'