1 # ============LICENSE_START=======================================================
2 # Copyright (c) 2021 Bell Canada.
3 # ================================================================================
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
16 # SPDX-License-Identifier: Apache-2.0
17 # ============LICENSE_END=========================================================
21 description: Create a new dataspace
24 summary: Create a dataspace
25 operationId: createDataspace
27 - $ref: 'components.yml#/components/parameters/dataspaceNameInQuery'
30 $ref: 'components.yml#/components/responses/Created'
32 $ref: 'components.yml#/components/responses/BadRequest'
34 $ref: 'components.yml#/components/responses/Unauthorized'
36 $ref: 'components.yml#/components/responses/Forbidden'
39 description: Delete a dataspace
42 summary: Delete a dataspace
43 operationId: deleteDataspace
45 - $ref: 'components.yml#/components/parameters/dataspaceNameInQuery'
48 $ref: 'components.yml#/components/responses/NoContent'
50 $ref: 'components.yml#/components/responses/BadRequest'
52 $ref: 'components.yml#/components/responses/Unauthorized'
54 $ref: 'components.yml#/components/responses/Forbidden'
56 $ref: 'components.yml#/components/responses/Conflict'
60 description: Create a new schema set in the given dataspace
63 summary: Create a schema set
64 operationId: createSchemaSet
66 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
67 - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
73 $ref: 'components.yml#/components/schemas/MultipartFile'
77 $ref: 'components.yml#/components/responses/Created'
79 $ref: 'components.yml#/components/responses/BadRequest'
81 $ref: 'components.yml#/components/responses/Unauthorized'
83 $ref: 'components.yml#/components/responses/Forbidden'
85 schemaSetBySchemaSetName:
87 description: Read a schema set given a schema set name and a dataspace
90 summary: Get a schema set
91 operationId: getSchemaSet
93 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
94 - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
101 $ref: 'components.yml#/components/schemas/SchemaSetDetails'
103 $ref: 'components.yml#/components/responses/BadRequest'
105 $ref: 'components.yml#/components/responses/Unauthorized'
107 $ref: 'components.yml#/components/responses/Forbidden'
109 $ref: 'components.yml#/components/responses/NotFound'
112 description: Delete a schema set given a schema set name and a dataspace
115 summary: Delete a schema set
116 operationId: deleteSchemaSet
118 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
119 - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
122 $ref: 'components.yml#/components/responses/NoContent'
124 $ref: 'components.yml#/components/responses/BadRequest'
126 $ref: 'components.yml#/components/responses/Unauthorized'
128 $ref: 'components.yml#/components/responses/Forbidden'
130 $ref: 'components.yml#/components/responses/Conflict'
134 description: Read all anchors, given a dataspace
138 operationId: getAnchors
140 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
149 $ref: 'components.yml#/components/schemas/AnchorDetails'
151 $ref: 'components.yml#/components/responses/BadRequest'
153 $ref: 'components.yml#/components/responses/Unauthorized'
155 $ref: 'components.yml#/components/responses/Forbidden'
157 $ref: 'components.yml#/components/responses/NotFound'
160 description: Create a new anchor in the given dataspace
163 summary: Create an anchor
164 operationId: createAnchor
166 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
167 - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
168 - $ref: 'components.yml#/components/parameters/anchorNameInQuery'
171 $ref: 'components.yml#/components/responses/Created'
173 $ref: 'components.yml#/components/responses/BadRequest'
175 $ref: 'components.yml#/components/responses/Unauthorized'
177 $ref: 'components.yml#/components/responses/Forbidden'
179 anchorByDataspaceAndAnchorName:
181 description: Read an anchor given an anchor name and a dataspace
184 summary: Get an anchor
185 operationId: getAnchor
187 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
188 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
195 $ref: 'components.yml#/components/schemas/AnchorDetails'
197 $ref: 'components.yml#/components/responses/BadRequest'
199 $ref: 'components.yml#/components/responses/Unauthorized'
201 $ref: 'components.yml#/components/responses/Forbidden'
203 $ref: 'components.yml#/components/responses/NotFound'
206 description: Delete an anchor given an anchor name and a dataspace
209 summary: Delete an anchor
210 operationId: deleteAnchor
212 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
213 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
216 $ref: 'components.yml#/components/responses/NoContent'
218 $ref: 'components.yml#/components/responses/BadRequest'
220 $ref: 'components.yml#/components/responses/Unauthorized'
222 $ref: 'components.yml#/components/responses/Forbidden'