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'
40 description: Create a new schema set in the given dataspace
43 summary: Create a schema set
44 operationId: createSchemaSet
46 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
47 - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
53 $ref: 'components.yml#/components/schemas/MultipartFile'
57 $ref: 'components.yml#/components/responses/Created'
59 $ref: 'components.yml#/components/responses/BadRequest'
61 $ref: 'components.yml#/components/responses/Unauthorized'
63 $ref: 'components.yml#/components/responses/Forbidden'
65 schemaSetBySchemaSetName:
67 description: Read a schema set given a schema set name and a dataspace
70 summary: Get a schema set
71 operationId: getSchemaSet
73 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
74 - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
81 $ref: 'components.yml#/components/schemas/SchemaSetDetails'
83 $ref: 'components.yml#/components/responses/BadRequest'
85 $ref: 'components.yml#/components/responses/Unauthorized'
87 $ref: 'components.yml#/components/responses/Forbidden'
89 $ref: 'components.yml#/components/responses/NotFound'
92 description: Delete a schema set given a schema set name and a dataspace
95 summary: Delete a schema set
96 operationId: deleteSchemaSet
98 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
99 - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
102 $ref: 'components.yml#/components/responses/NoContent'
104 $ref: 'components.yml#/components/responses/BadRequest'
106 $ref: 'components.yml#/components/responses/Unauthorized'
108 $ref: 'components.yml#/components/responses/Forbidden'
110 $ref: 'components.yml#/components/responses/Conflict'
114 description: Read all anchors, given a dataspace
118 operationId: getAnchors
120 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
129 $ref: 'components.yml#/components/schemas/AnchorDetails'
131 $ref: 'components.yml#/components/responses/BadRequest'
133 $ref: 'components.yml#/components/responses/Unauthorized'
135 $ref: 'components.yml#/components/responses/Forbidden'
137 $ref: 'components.yml#/components/responses/NotFound'
140 description: Create a new anchor in the given dataspace
143 summary: Create an anchor
144 operationId: createAnchor
146 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
147 - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
148 - $ref: 'components.yml#/components/parameters/anchorNameInQuery'
151 $ref: 'components.yml#/components/responses/Created'
153 $ref: 'components.yml#/components/responses/BadRequest'
155 $ref: 'components.yml#/components/responses/Unauthorized'
157 $ref: 'components.yml#/components/responses/Forbidden'
159 anchorByDataspaceAndAnchorName:
161 description: Read an anchor given an anchor name and a dataspace
164 summary: Get an anchor
165 operationId: getAnchor
167 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
168 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
175 $ref: 'components.yml#/components/schemas/AnchorDetails'
177 $ref: 'components.yml#/components/responses/BadRequest'
179 $ref: 'components.yml#/components/responses/Unauthorized'
181 $ref: 'components.yml#/components/responses/Forbidden'
183 $ref: 'components.yml#/components/responses/NotFound'
186 description: Delete an anchor given an anchor name and a dataspace
189 summary: Delete an anchor
190 operationId: deleteAnchor
192 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
193 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
196 $ref: 'components.yml#/components/responses/NoContent'
198 $ref: 'components.yml#/components/responses/BadRequest'
200 $ref: 'components.yml#/components/responses/Unauthorized'
202 $ref: 'components.yml#/components/responses/Forbidden'