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.
15 # ============LICENSE_END=========================================================
19 description: Create a new dataspace
22 summary: Create a dataspace
23 operationId: createDataspace
25 - $ref: 'components.yml#/components/parameters/dataspaceNameInQuery'
28 $ref: 'components.yml#/components/responses/Created'
30 $ref: 'components.yml#/components/responses/BadRequest'
32 $ref: 'components.yml#/components/responses/Unauthorized'
34 $ref: 'components.yml#/components/responses/Forbidden'
36 dataspaceByDataspaceName:
38 description: Delete the given dataspace - DRAFT
41 summary: Delete a dataspace
42 operationId: deleteDataspace
44 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
47 $ref: 'components.yml#/components/responses/Ok'
49 $ref: 'components.yml#/components/responses/NoContent'
51 $ref: 'components.yml#/components/responses/BadRequest'
53 $ref: 'components.yml#/components/responses/Unauthorized'
55 $ref: 'components.yml#/components/responses/Forbidden'
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'
97 $ref: 'components.yml#/components/responses/Ok'
99 $ref: 'components.yml#/components/responses/BadRequest'
101 $ref: 'components.yml#/components/responses/Unauthorized'
103 $ref: 'components.yml#/components/responses/Forbidden'
105 $ref: 'components.yml#/components/responses/NotFound'
108 description: Delete a schema set given a schema set name and a dataspace
111 summary: Delete a schema set
112 operationId: deleteSchemaSet
114 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
115 - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
118 $ref: 'components.yml#/components/responses/NoContent'
120 $ref: 'components.yml#/components/responses/BadRequest'
122 $ref: 'components.yml#/components/responses/Unauthorized'
124 $ref: 'components.yml#/components/responses/Forbidden'
126 $ref: 'components.yml#/components/responses/Conflict'
130 description: Read all anchors, given a dataspace
134 operationId: getAnchors
136 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
139 $ref: 'components.yml#/components/responses/Ok'
141 $ref: 'components.yml#/components/responses/BadRequest'
143 $ref: 'components.yml#/components/responses/Unauthorized'
145 $ref: 'components.yml#/components/responses/Forbidden'
147 $ref: 'components.yml#/components/responses/NotFound'
150 description: Create a new anchor in the given dataspace
153 summary: Create an anchor
154 operationId: createAnchor
156 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
157 - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
158 - $ref: 'components.yml#/components/parameters/anchorNameInQuery'
161 $ref: 'components.yml#/components/responses/Created'
163 $ref: 'components.yml#/components/responses/BadRequest'
165 $ref: 'components.yml#/components/responses/Unauthorized'
167 $ref: 'components.yml#/components/responses/Forbidden'
169 anchorByDataspaceAndAnchorName:
171 description: Read an anchor given an anchor name and a dataspace
174 summary: Get an anchor
175 operationId: getAnchor
177 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
178 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
181 $ref: 'components.yml#/components/responses/Ok'
183 $ref: 'components.yml#/components/responses/BadRequest'
185 $ref: 'components.yml#/components/responses/Unauthorized'
187 $ref: 'components.yml#/components/responses/Forbidden'
189 $ref: 'components.yml#/components/responses/NotFound'
192 description: Delete an anchor given an anchor name and a dataspace
195 summary: Delete an anchor
196 operationId: deleteAnchor
198 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
199 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
202 $ref: 'components.yml#/components/responses/NoContent'
204 $ref: 'components.yml#/components/responses/BadRequest'
206 $ref: 'components.yml#/components/responses/Unauthorized'
208 $ref: 'components.yml#/components/responses/Forbidden'