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: Delete a dataspace
26 summary: Delete a dataspace
27 operationId: deleteDataspace
29 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
30 - $ref: 'components.yml#/components/parameters/dataspaceNameInQuery'
33 $ref: 'components.yml#/components/responses/NoContent'
35 $ref: 'components.yml#/components/responses/BadRequest'
37 $ref: 'components.yml#/components/responses/Unauthorized'
39 $ref: 'components.yml#/components/responses/Forbidden'
41 $ref: 'components.yml#/components/responses/Conflict'
43 $ref: 'components.yml#/components/responses/InternalServerError'
47 description: Read all schema sets, given a dataspace
50 summary: Get schema sets
51 operationId: getSchemaSets
53 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
54 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
63 $ref: 'components.yml#/components/schemas/SchemaSetDetails'
65 $ref: 'components.yml#/components/responses/BadRequest'
67 $ref: 'components.yml#/components/responses/Unauthorized'
69 $ref: 'components.yml#/components/responses/Forbidden'
71 $ref: 'components.yml#/components/responses/InternalServerError'
73 schemaSetBySchemaSetName:
75 description: Read a schema set given a schema set name and a dataspace
78 summary: Get a schema set
79 operationId: getSchemaSet
81 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
82 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
83 - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
90 $ref: 'components.yml#/components/schemas/SchemaSetDetails'
92 $ref: 'components.yml#/components/responses/BadRequest'
94 $ref: 'components.yml#/components/responses/Unauthorized'
96 $ref: 'components.yml#/components/responses/Forbidden'
98 $ref: 'components.yml#/components/responses/InternalServerError'
100 description: Delete a schema set given a schema set name and a dataspace
103 summary: Delete a schema set
104 operationId: deleteSchemaSet
106 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
107 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
108 - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
111 $ref: 'components.yml#/components/responses/NoContent'
113 $ref: 'components.yml#/components/responses/BadRequest'
115 $ref: 'components.yml#/components/responses/Unauthorized'
117 $ref: 'components.yml#/components/responses/Forbidden'
119 $ref: 'components.yml#/components/responses/Conflict'
121 $ref: 'components.yml#/components/responses/InternalServerError'
125 description: Read all anchors, given a dataspace
129 operationId: getAnchors
131 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
132 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
141 $ref: 'components.yml#/components/schemas/AnchorDetails'
143 $ref: 'components.yml#/components/responses/BadRequest'
145 $ref: 'components.yml#/components/responses/Unauthorized'
147 $ref: 'components.yml#/components/responses/Forbidden'
149 $ref: 'components.yml#/components/responses/InternalServerError'
151 anchorByDataspaceAndAnchorName:
153 description: Read an anchor given an anchor name and a dataspace
156 summary: Get an anchor
157 operationId: getAnchor
159 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
160 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
161 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
168 $ref: 'components.yml#/components/schemas/AnchorDetails'
170 $ref: 'components.yml#/components/responses/BadRequest'
172 $ref: 'components.yml#/components/responses/Unauthorized'
174 $ref: 'components.yml#/components/responses/Forbidden'
176 $ref: 'components.yml#/components/responses/InternalServerError'
178 description: Delete an anchor given an anchor name and a dataspace
181 summary: Delete an anchor
182 operationId: deleteAnchor
184 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
185 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
186 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
189 $ref: 'components.yml#/components/responses/NoContent'
191 $ref: 'components.yml#/components/responses/BadRequest'
193 $ref: 'components.yml#/components/responses/Unauthorized'
195 $ref: 'components.yml#/components/responses/Forbidden'
197 $ref: 'components.yml#/components/responses/InternalServerError'
201 description: Read all dataspaces
204 summary: Get all dataspaces
205 operationId: getAllDataspaces
207 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
216 $ref: 'components.yml#/components/schemas/DataspaceDetails'
218 $ref: 'components.yml#/components/responses/BadRequest'
220 $ref: 'components.yml#/components/responses/Unauthorized'
222 $ref: 'components.yml#/components/responses/Forbidden'
224 $ref: 'components.yml#/components/responses/InternalServerError'
228 description: Read a dataspace given a dataspace name
231 summary: Get a dataspace
232 operationId: getDataspace
234 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
235 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
242 $ref: 'components.yml#/components/schemas/DataspaceDetails'
244 $ref: 'components.yml#/components/responses/BadRequest'
246 $ref: 'components.yml#/components/responses/Unauthorized'
248 $ref: 'components.yml#/components/responses/Forbidden'
250 $ref: 'components.yml#/components/responses/InternalServerError'