Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / 58d3763eb70a1f857f1b434965037c9d4916c4a2 / . / cps-rest / docs / openapi / cpsAdmin.yml
blob: f60a9be6ff5e74990bf2b3185a0278ed632eb13f [file] [log] [blame]
shivasubedi8df61a92021-06-16 14:43:18 +0100[diff] [blame]1# ============LICENSE_START=======================================================
2# Copyright (c) 2021 Bell Canada.
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]3# Modifications Copyright (C) 2021-2022 Nordix Foundation
rajesh.kumarcec0cb72022-09-06 11:47:18 +0000[diff] [blame]4# Modifications Copyright (C) 2022 TechMahindra Ltd.
shivasubedi8df61a92021-06-16 14:43:18 +0100[diff] [blame]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
9#
10# http://www.apache.org/licenses/LICENSE-2.0
11#
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.
Renu Kumari4d520012021-08-30 11:50:43 -0400[diff] [blame]17#
18# SPDX-License-Identifier: Apache-2.0
shivasubedi8df61a92021-06-16 14:43:18 +0100[diff] [blame]19# ============LICENSE_END=========================================================
20
Rishi.Chaildacc6632021-01-27 04:27:34 +0000[diff] [blame]21dataspaces:
niamhcore09c6b6e2021-11-22 11:44:38 +0000[diff] [blame]22 delete:
23 description: Delete a dataspace
24 tags:
25 - cps-admin
26 summary: Delete a dataspace
27 operationId: deleteDataspace
28 parameters:
rajesh.kumar897686f2022-12-14 08:13:29 +0000[diff] [blame]29 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
niamhcore09c6b6e2021-11-22 11:44:38 +0000[diff] [blame]30 - $ref: 'components.yml#/components/parameters/dataspaceNameInQuery'
31 responses:
32 '204':
33 $ref: 'components.yml#/components/responses/NoContent'
34 '400':
35 $ref: 'components.yml#/components/responses/BadRequest'
36 '401':
37 $ref: 'components.yml#/components/responses/Unauthorized'
38 '403':
39 $ref: 'components.yml#/components/responses/Forbidden'
40 '409':
41 $ref: 'components.yml#/components/responses/Conflict'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]42 '500':
43 $ref: 'components.yml#/components/responses/InternalServerError'
niamhcore09c6b6e2021-11-22 11:44:38 +0000[diff] [blame]44
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]45schemaSet:
rajesh.kumar71e4f832022-09-14 05:11:32 +0000[diff] [blame]46 get:
47 description: Read all schema sets, given a dataspace
48 tags:
49 - cps-admin
50 summary: Get schema sets
51 operationId: getSchemaSets
52 parameters:
rajesh.kumar897686f2022-12-14 08:13:29 +0000[diff] [blame]53 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
rajesh.kumar71e4f832022-09-14 05:11:32 +0000[diff] [blame]54 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
55 responses:
56 '200':
57 description: OK
58 content:
59 application/json:
60 schema:
61 type: array
62 items:
63 $ref: 'components.yml#/components/schemas/SchemaSetDetails'
64 '400':
65 $ref: 'components.yml#/components/responses/BadRequest'
66 '401':
67 $ref: 'components.yml#/components/responses/Unauthorized'
68 '403':
69 $ref: 'components.yml#/components/responses/Forbidden'
70 '500':
71 $ref: 'components.yml#/components/responses/InternalServerError'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]72
73schemaSetBySchemaSetName:
74 get:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]75 description: Read a schema set given a schema set name and a dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]76 tags:
77 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]78 summary: Get a schema set
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]79 operationId: getSchemaSet
80 parameters:
rajesh.kumar897686f2022-12-14 08:13:29 +0000[diff] [blame]81 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]82 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
83 - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]84 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]85 '200':
JosephKeenanc6865f32021-06-08 13:16:37 +0100[diff] [blame]86 description: OK
87 content:
88 application/json:
89 schema:
90 $ref: 'components.yml#/components/schemas/SchemaSetDetails'
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]91 '400':
92 $ref: 'components.yml#/components/responses/BadRequest'
93 '401':
94 $ref: 'components.yml#/components/responses/Unauthorized'
95 '403':
96 $ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]97 '500':
98 $ref: 'components.yml#/components/responses/InternalServerError'
Ruslan Kashapovdce4e312021-01-11 15:34:10 +0200[diff] [blame]99 delete:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]100 description: Delete a schema set given a schema set name and a dataspace
Ruslan Kashapovdce4e312021-01-11 15:34:10 +0200[diff] [blame]101 tags:
102 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]103 summary: Delete a schema set
Ruslan Kashapovdce4e312021-01-11 15:34:10 +0200[diff] [blame]104 operationId: deleteSchemaSet
105 parameters:
rajesh.kumar897686f2022-12-14 08:13:29 +0000[diff] [blame]106 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]107 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
108 - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
Ruslan Kashapovdce4e312021-01-11 15:34:10 +0200[diff] [blame]109 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]110 '204':
111 $ref: 'components.yml#/components/responses/NoContent'
112 '400':
113 $ref: 'components.yml#/components/responses/BadRequest'
114 '401':
115 $ref: 'components.yml#/components/responses/Unauthorized'
116 '403':
117 $ref: 'components.yml#/components/responses/Forbidden'
118 '409':
119 $ref: 'components.yml#/components/responses/Conflict'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]120 '500':
121 $ref: 'components.yml#/components/responses/InternalServerError'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]122
123anchorsByDataspace:
124 get:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]125 description: Read all anchors, given a dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]126 tags:
127 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]128 summary: Get anchors
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]129 operationId: getAnchors
130 parameters:
rajesh.kumar897686f2022-12-14 08:13:29 +0000[diff] [blame]131 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]132 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]133 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]134 '200':
JosephKeenanc6865f32021-06-08 13:16:37 +0100[diff] [blame]135 description: OK
136 content:
137 application/json:
138 schema:
139 type: array
140 items:
141 $ref: 'components.yml#/components/schemas/AnchorDetails'
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]142 '400':
143 $ref: 'components.yml#/components/responses/BadRequest'
144 '401':
145 $ref: 'components.yml#/components/responses/Unauthorized'
146 '403':
147 $ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]148 '500':
149 $ref: 'components.yml#/components/responses/InternalServerError'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]150
151anchorByDataspaceAndAnchorName:
152 get:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]153 description: Read an anchor given an anchor name and a dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]154 tags:
155 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]156 summary: Get an anchor
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]157 operationId: getAnchor
158 parameters:
rajesh.kumar897686f2022-12-14 08:13:29 +0000[diff] [blame]159 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]160 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
161 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]162 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]163 '200':
JosephKeenanc6865f32021-06-08 13:16:37 +0100[diff] [blame]164 description: OK
165 content:
166 application/json:
167 schema:
168 $ref: 'components.yml#/components/schemas/AnchorDetails'
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]169 '400':
170 $ref: 'components.yml#/components/responses/BadRequest'
171 '401':
172 $ref: 'components.yml#/components/responses/Unauthorized'
173 '403':
174 $ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]175 '500':
176 $ref: 'components.yml#/components/responses/InternalServerError'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]177 delete:
Ruslan Kashapovb20858b2021-04-05 14:46:03 +0300[diff] [blame]178 description: Delete an anchor given an anchor name and a dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]179 tags:
180 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]181 summary: Delete an anchor
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]182 operationId: deleteAnchor
183 parameters:
rajesh.kumar897686f2022-12-14 08:13:29 +0000[diff] [blame]184 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]185 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
186 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]187 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]188 '204':
189 $ref: 'components.yml#/components/responses/NoContent'
190 '400':
191 $ref: 'components.yml#/components/responses/BadRequest'
192 '401':
193 $ref: 'components.yml#/components/responses/Unauthorized'
194 '403':
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]195 $ref: 'components.yml#/components/responses/Forbidden'
196 '500':
rajesh.kumarcec0cb72022-09-06 11:47:18 +0000[diff] [blame]197 $ref: 'components.yml#/components/responses/InternalServerError'
198
199adminDataspaces:
200 get:
201 description: Read all dataspaces
202 tags:
203 - cps-admin
204 summary: Get all dataspaces
205 operationId: getAllDataspaces
rajesh.kumar897686f2022-12-14 08:13:29 +0000[diff] [blame]206 parameters:
207 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
rajesh.kumarcec0cb72022-09-06 11:47:18 +0000[diff] [blame]208 responses:
209 '200':
210 description: OK
211 content:
212 application/json:
213 schema:
214 type: array
215 items:
216 $ref: 'components.yml#/components/schemas/DataspaceDetails'
217 '400':
218 $ref: 'components.yml#/components/responses/BadRequest'
219 '401':
220 $ref: 'components.yml#/components/responses/Unauthorized'
221 '403':
222 $ref: 'components.yml#/components/responses/Forbidden'
223 '500':
224 $ref: 'components.yml#/components/responses/InternalServerError'
225
226adminDataspace:
227 get:
228 description: Read a dataspace given a dataspace name
229 tags:
230 - cps-admin
231 summary: Get a dataspace
232 operationId: getDataspace
233 parameters:
rajesh.kumar897686f2022-12-14 08:13:29 +0000[diff] [blame]234 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
rajesh.kumarcec0cb72022-09-06 11:47:18 +0000[diff] [blame]235 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
236 responses:
237 '200':
238 description: OK
239 content:
240 application/json:
241 schema:
242 $ref: 'components.yml#/components/schemas/DataspaceDetails'
243 '400':
244 $ref: 'components.yml#/components/responses/BadRequest'
245 '401':
246 $ref: 'components.yml#/components/responses/Unauthorized'
247 '403':
248 $ref: 'components.yml#/components/responses/Forbidden'
249 '500':
250 $ref: 'components.yml#/components/responses/InternalServerError'