Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / 05701dda6edf6b8e7c06699a7b44247359c46cfb / . / cps-rest / src / main / resources / static / cpsAdmin.yml
blob: 35b2e4ca6a441fa2ca54c4e28b7860d036f76e06 [file] [log] [blame]
shivasubedi8df61a92021-06-16 14:43:18 +0100[diff] [blame]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
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
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=========================================================
16
Rishi.Chaildacc6632021-01-27 04:27:34 +0000[diff] [blame]17dataspaces:
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]18 post:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]19 description: Create a new dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]20 tags:
21 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]22 summary: Create a dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]23 operationId: createDataspace
24 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]25 - $ref: 'components.yml#/components/parameters/dataspaceNameInQuery'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]26 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]27 '201':
28 $ref: 'components.yml#/components/responses/Created'
29 '400':
30 $ref: 'components.yml#/components/responses/BadRequest'
31 '401':
32 $ref: 'components.yml#/components/responses/Unauthorized'
33 '403':
34 $ref: 'components.yml#/components/responses/Forbidden'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]35
36dataspaceByDataspaceName:
37 delete:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]38 description: Delete the given dataspace - DRAFT
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]39 tags:
40 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]41 summary: Delete a dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]42 operationId: deleteDataspace
43 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]44 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]45 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]46 '200':
47 $ref: 'components.yml#/components/responses/Ok'
48 '204':
49 $ref: 'components.yml#/components/responses/NoContent'
50 '400':
51 $ref: 'components.yml#/components/responses/BadRequest'
52 '401':
53 $ref: 'components.yml#/components/responses/Unauthorized'
54 '403':
55 $ref: 'components.yml#/components/responses/Forbidden'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]56
57
58schemaSet:
59 post:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]60 description: Create a new schema set in the given dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]61 tags:
62 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]63 summary: Create a schema set
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]64 operationId: createSchemaSet
65 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]66 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
67 - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]68 requestBody:
69 required: true
70 content:
71 multipart/form-data:
72 schema:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]73 $ref: 'components.yml#/components/schemas/MultipartFile'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]74
75 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]76 '201':
77 $ref: 'components.yml#/components/responses/Created'
78 '400':
79 $ref: 'components.yml#/components/responses/BadRequest'
80 '401':
81 $ref: 'components.yml#/components/responses/Unauthorized'
82 '403':
83 $ref: 'components.yml#/components/responses/Forbidden'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]84
85schemaSetBySchemaSetName:
86 get:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]87 description: Read a schema set given a schema set name and a dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]88 tags:
89 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]90 summary: Get a schema set
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]91 operationId: getSchemaSet
92 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]93 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
94 - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]95 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]96 '200':
JosephKeenanc6865f32021-06-08 13:16:37 +0100[diff] [blame]97 description: OK
98 content:
99 application/json:
100 schema:
101 $ref: 'components.yml#/components/schemas/SchemaSetDetails'
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]102 '400':
103 $ref: 'components.yml#/components/responses/BadRequest'
104 '401':
105 $ref: 'components.yml#/components/responses/Unauthorized'
106 '403':
107 $ref: 'components.yml#/components/responses/Forbidden'
108 '404':
109 $ref: 'components.yml#/components/responses/NotFound'
110
Ruslan Kashapovdce4e312021-01-11 15:34:10 +0200[diff] [blame]111 delete:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]112 description: Delete a schema set given a schema set name and a dataspace
Ruslan Kashapovdce4e312021-01-11 15:34:10 +0200[diff] [blame]113 tags:
114 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]115 summary: Delete a schema set
Ruslan Kashapovdce4e312021-01-11 15:34:10 +0200[diff] [blame]116 operationId: deleteSchemaSet
117 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]118 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
119 - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
Ruslan Kashapovdce4e312021-01-11 15:34:10 +0200[diff] [blame]120 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]121 '204':
122 $ref: 'components.yml#/components/responses/NoContent'
123 '400':
124 $ref: 'components.yml#/components/responses/BadRequest'
125 '401':
126 $ref: 'components.yml#/components/responses/Unauthorized'
127 '403':
128 $ref: 'components.yml#/components/responses/Forbidden'
129 '409':
130 $ref: 'components.yml#/components/responses/Conflict'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]131
132anchorsByDataspace:
133 get:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]134 description: Read all anchors, given a dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]135 tags:
136 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]137 summary: Get anchors
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]138 operationId: getAnchors
139 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]140 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]141 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]142 '200':
JosephKeenanc6865f32021-06-08 13:16:37 +0100[diff] [blame]143 description: OK
144 content:
145 application/json:
146 schema:
147 type: array
148 items:
149 $ref: 'components.yml#/components/schemas/AnchorDetails'
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]150 '400':
151 $ref: 'components.yml#/components/responses/BadRequest'
152 '401':
153 $ref: 'components.yml#/components/responses/Unauthorized'
154 '403':
155 $ref: 'components.yml#/components/responses/Forbidden'
156 '404':
157 $ref: 'components.yml#/components/responses/NotFound'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]158
159 post:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]160 description: Create a new anchor in the given dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]161 tags:
162 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]163 summary: Create an anchor
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]164 operationId: createAnchor
165 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]166 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
167 - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
168 - $ref: 'components.yml#/components/parameters/anchorNameInQuery'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]169 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]170 '201':
171 $ref: 'components.yml#/components/responses/Created'
172 '400':
173 $ref: 'components.yml#/components/responses/BadRequest'
174 '401':
175 $ref: 'components.yml#/components/responses/Unauthorized'
176 '403':
177 $ref: 'components.yml#/components/responses/Forbidden'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]178
179anchorByDataspaceAndAnchorName:
180 get:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]181 description: Read an anchor given an anchor name and a dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]182 tags:
183 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]184 summary: Get an anchor
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]185 operationId: getAnchor
186 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]187 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
188 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]189 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]190 '200':
JosephKeenanc6865f32021-06-08 13:16:37 +0100[diff] [blame]191 description: OK
192 content:
193 application/json:
194 schema:
195 $ref: 'components.yml#/components/schemas/AnchorDetails'
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]196 '400':
197 $ref: 'components.yml#/components/responses/BadRequest'
198 '401':
199 $ref: 'components.yml#/components/responses/Unauthorized'
200 '403':
201 $ref: 'components.yml#/components/responses/Forbidden'
202 '404':
203 $ref: 'components.yml#/components/responses/NotFound'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]204
205 delete:
Ruslan Kashapovb20858b2021-04-05 14:46:03 +0300[diff] [blame]206 description: Delete an anchor given an anchor name and a dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]207 tags:
208 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]209 summary: Delete an anchor
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]210 operationId: deleteAnchor
211 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]212 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
213 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]214 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]215 '204':
216 $ref: 'components.yml#/components/responses/NoContent'
217 '400':
218 $ref: 'components.yml#/components/responses/BadRequest'
219 '401':
220 $ref: 'components.yml#/components/responses/Unauthorized'
221 '403':
JosephKeenanc6865f32021-06-08 13:16:37 +0100[diff] [blame]222 $ref: 'components.yml#/components/responses/Forbidden'