Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / c4adf98d2cc8cc02911176d326f1c22f36183e24 / . / cps-rest / docs / openapi / cpsAdmin.yml
blob: a25f81eafc95e7cff4aa3f1031a1d379fa7d62e2 [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
shivasubedi8df61a92021-06-16 14:43:18 +0100[diff] [blame]4# ================================================================================
5# Licensed under the Apache License, Version 2.0 (the "License");
6# you may not use this file except in compliance with the License.
7# You may obtain a copy of the License at
8#
9# http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an "AS IS" BASIS,
13# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14# See the License for the specific language governing permissions and
15# limitations under the License.
Renu Kumari4d520012021-08-30 11:50:43 -0400[diff] [blame]16#
17# SPDX-License-Identifier: Apache-2.0
shivasubedi8df61a92021-06-16 14:43:18 +0100[diff] [blame]18# ============LICENSE_END=========================================================
19
Rishi.Chaildacc6632021-01-27 04:27:34 +0000[diff] [blame]20dataspaces:
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]21 post:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]22 description: Create a new dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]23 tags:
24 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]25 summary: Create a dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]26 operationId: createDataspace
27 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]28 - $ref: 'components.yml#/components/parameters/dataspaceNameInQuery'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]29 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]30 '201':
31 $ref: 'components.yml#/components/responses/Created'
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]32 '401':
33 $ref: 'components.yml#/components/responses/Unauthorized'
34 '403':
35 $ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]36 '409':
37 $ref: 'components.yml#/components/responses/Conflict'
38 '500':
39 $ref: 'components.yml#/components/responses/InternalServerError'
niamhcore09c6b6e2021-11-22 11:44:38 +0000[diff] [blame]40 delete:
41 description: Delete a dataspace
42 tags:
43 - cps-admin
44 summary: Delete a dataspace
45 operationId: deleteDataspace
46 parameters:
47 - $ref: 'components.yml#/components/parameters/dataspaceNameInQuery'
48 responses:
49 '204':
50 $ref: 'components.yml#/components/responses/NoContent'
51 '400':
52 $ref: 'components.yml#/components/responses/BadRequest'
53 '401':
54 $ref: 'components.yml#/components/responses/Unauthorized'
55 '403':
56 $ref: 'components.yml#/components/responses/Forbidden'
57 '409':
58 $ref: 'components.yml#/components/responses/Conflict'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]59 '500':
60 $ref: 'components.yml#/components/responses/InternalServerError'
niamhcore09c6b6e2021-11-22 11:44:38 +0000[diff] [blame]61
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]62schemaSet:
63 post:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]64 description: Create a new schema set in the given dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]65 tags:
66 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]67 summary: Create a schema set
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]68 operationId: createSchemaSet
69 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]70 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
71 - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]72 requestBody:
73 required: true
74 content:
75 multipart/form-data:
76 schema:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]77 $ref: 'components.yml#/components/schemas/MultipartFile'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]78 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]79 '201':
80 $ref: 'components.yml#/components/responses/Created'
81 '400':
82 $ref: 'components.yml#/components/responses/BadRequest'
83 '401':
84 $ref: 'components.yml#/components/responses/Unauthorized'
85 '403':
86 $ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]87 '409':
88 $ref: 'components.yml#/components/responses/Conflict'
89 '500':
90 $ref: 'components.yml#/components/responses/InternalServerError'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]91
92schemaSetBySchemaSetName:
93 get:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]94 description: Read a schema set given a schema set name and a dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]95 tags:
96 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]97 summary: Get a schema set
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]98 operationId: getSchemaSet
99 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]100 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
101 - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]102 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]103 '200':
JosephKeenanc6865f32021-06-08 13:16:37 +0100[diff] [blame]104 description: OK
105 content:
106 application/json:
107 schema:
108 $ref: 'components.yml#/components/schemas/SchemaSetDetails'
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]109 '400':
110 $ref: 'components.yml#/components/responses/BadRequest'
111 '401':
112 $ref: 'components.yml#/components/responses/Unauthorized'
113 '403':
114 $ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]115 '500':
116 $ref: 'components.yml#/components/responses/InternalServerError'
Ruslan Kashapovdce4e312021-01-11 15:34:10 +0200[diff] [blame]117 delete:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]118 description: Delete a schema set given a schema set name and a dataspace
Ruslan Kashapovdce4e312021-01-11 15:34:10 +0200[diff] [blame]119 tags:
120 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]121 summary: Delete a schema set
Ruslan Kashapovdce4e312021-01-11 15:34:10 +0200[diff] [blame]122 operationId: deleteSchemaSet
123 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]124 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
125 - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
Ruslan Kashapovdce4e312021-01-11 15:34:10 +0200[diff] [blame]126 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]127 '204':
128 $ref: 'components.yml#/components/responses/NoContent'
129 '400':
130 $ref: 'components.yml#/components/responses/BadRequest'
131 '401':
132 $ref: 'components.yml#/components/responses/Unauthorized'
133 '403':
134 $ref: 'components.yml#/components/responses/Forbidden'
135 '409':
136 $ref: 'components.yml#/components/responses/Conflict'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]137 '500':
138 $ref: 'components.yml#/components/responses/InternalServerError'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]139
140anchorsByDataspace:
141 get:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]142 description: Read all anchors, given a dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]143 tags:
144 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]145 summary: Get anchors
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]146 operationId: getAnchors
147 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]148 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]149 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]150 '200':
JosephKeenanc6865f32021-06-08 13:16:37 +0100[diff] [blame]151 description: OK
152 content:
153 application/json:
154 schema:
155 type: array
156 items:
157 $ref: 'components.yml#/components/schemas/AnchorDetails'
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]158 '400':
159 $ref: 'components.yml#/components/responses/BadRequest'
160 '401':
161 $ref: 'components.yml#/components/responses/Unauthorized'
162 '403':
163 $ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]164 '500':
165 $ref: 'components.yml#/components/responses/InternalServerError'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]166 post:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]167 description: Create a new anchor in the given dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]168 tags:
169 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]170 summary: Create an anchor
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]171 operationId: createAnchor
172 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]173 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
174 - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
175 - $ref: 'components.yml#/components/parameters/anchorNameInQuery'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]176 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]177 '201':
178 $ref: 'components.yml#/components/responses/Created'
179 '400':
180 $ref: 'components.yml#/components/responses/BadRequest'
181 '401':
182 $ref: 'components.yml#/components/responses/Unauthorized'
183 '403':
184 $ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]185 '409':
186 $ref: 'components.yml#/components/responses/Conflict'
187 '500':
188 $ref: 'components.yml#/components/responses/InternalServerError'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]189
190anchorByDataspaceAndAnchorName:
191 get:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]192 description: Read an anchor given an anchor name and a dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]193 tags:
194 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]195 summary: Get an anchor
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]196 operationId: getAnchor
197 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]198 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
199 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]200 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]201 '200':
JosephKeenanc6865f32021-06-08 13:16:37 +0100[diff] [blame]202 description: OK
203 content:
204 application/json:
205 schema:
206 $ref: 'components.yml#/components/schemas/AnchorDetails'
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]207 '400':
208 $ref: 'components.yml#/components/responses/BadRequest'
209 '401':
210 $ref: 'components.yml#/components/responses/Unauthorized'
211 '403':
212 $ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]213 '500':
214 $ref: 'components.yml#/components/responses/InternalServerError'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]215 delete:
Ruslan Kashapovb20858b2021-04-05 14:46:03 +0300[diff] [blame]216 description: Delete an anchor given an anchor name and a dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]217 tags:
218 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]219 summary: Delete an anchor
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]220 operationId: deleteAnchor
221 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]222 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
223 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]224 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]225 '204':
226 $ref: 'components.yml#/components/responses/NoContent'
227 '400':
228 $ref: 'components.yml#/components/responses/BadRequest'
229 '401':
230 $ref: 'components.yml#/components/responses/Unauthorized'
231 '403':
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]232 $ref: 'components.yml#/components/responses/Forbidden'
233 '500':
234 $ref: 'components.yml#/components/responses/InternalServerError'