Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / 8df61a97b4c1798ade8034cb481943fe6da65322 / . / cps-rest / docs / openapi / cpsAdmin.yml
blob: cb5594868654783a35dcdab08a4a3a3313bc22dc [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':
97 $ref: 'components.yml#/components/responses/Ok'
98 '400':
99 $ref: 'components.yml#/components/responses/BadRequest'
100 '401':
101 $ref: 'components.yml#/components/responses/Unauthorized'
102 '403':
103 $ref: 'components.yml#/components/responses/Forbidden'
104 '404':
105 $ref: 'components.yml#/components/responses/NotFound'
106
Ruslan Kashapovdce4e312021-01-11 15:34:10 +0200[diff] [blame]107 delete:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]108 description: Delete a schema set given a schema set name and a dataspace
Ruslan Kashapovdce4e312021-01-11 15:34:10 +0200[diff] [blame]109 tags:
110 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]111 summary: Delete a schema set
Ruslan Kashapovdce4e312021-01-11 15:34:10 +0200[diff] [blame]112 operationId: deleteSchemaSet
113 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]114 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
115 - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
Ruslan Kashapovdce4e312021-01-11 15:34:10 +0200[diff] [blame]116 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]117 '204':
118 $ref: 'components.yml#/components/responses/NoContent'
119 '400':
120 $ref: 'components.yml#/components/responses/BadRequest'
121 '401':
122 $ref: 'components.yml#/components/responses/Unauthorized'
123 '403':
124 $ref: 'components.yml#/components/responses/Forbidden'
125 '409':
126 $ref: 'components.yml#/components/responses/Conflict'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]127
128anchorsByDataspace:
129 get:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]130 description: Read all anchors, given a dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]131 tags:
132 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]133 summary: Get anchors
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]134 operationId: getAnchors
135 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]136 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]137 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]138 '200':
139 $ref: 'components.yml#/components/responses/Ok'
140 '400':
141 $ref: 'components.yml#/components/responses/BadRequest'
142 '401':
143 $ref: 'components.yml#/components/responses/Unauthorized'
144 '403':
145 $ref: 'components.yml#/components/responses/Forbidden'
146 '404':
147 $ref: 'components.yml#/components/responses/NotFound'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]148
149 post:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]150 description: Create a new anchor in the given dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]151 tags:
152 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]153 summary: Create an anchor
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]154 operationId: createAnchor
155 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]156 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
157 - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
158 - $ref: 'components.yml#/components/parameters/anchorNameInQuery'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]159 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]160 '201':
161 $ref: 'components.yml#/components/responses/Created'
162 '400':
163 $ref: 'components.yml#/components/responses/BadRequest'
164 '401':
165 $ref: 'components.yml#/components/responses/Unauthorized'
166 '403':
167 $ref: 'components.yml#/components/responses/Forbidden'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]168
169anchorByDataspaceAndAnchorName:
170 get:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]171 description: Read an anchor given an anchor name and a dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]172 tags:
173 - cps-admin
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]174 summary: Get an anchor
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]175 operationId: getAnchor
176 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]177 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
178 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]179 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]180 '200':
181 $ref: 'components.yml#/components/responses/Ok'
182 '400':
183 $ref: 'components.yml#/components/responses/BadRequest'
184 '401':
185 $ref: 'components.yml#/components/responses/Unauthorized'
186 '403':
187 $ref: 'components.yml#/components/responses/Forbidden'
188 '404':
189 $ref: 'components.yml#/components/responses/NotFound'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]190
191 delete:
Ruslan Kashapovb20858b2021-04-05 14:46:03 +0300[diff] [blame]192 description: Delete 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: Delete an anchor
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]196 operationId: deleteAnchor
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 '204':
202 $ref: 'components.yml#/components/responses/NoContent'
203 '400':
204 $ref: 'components.yml#/components/responses/BadRequest'
205 '401':
206 $ref: 'components.yml#/components/responses/Unauthorized'
207 '403':
208 $ref: 'components.yml#/components/responses/Forbidden'