shivasubedi | 8df61a9 | 2021-06-16 14:43:18 +0100 | [diff] [blame] | 1 | # ============LICENSE_START======================================================= |
puthuparambil.aditya | cc17ae5 | 2022-02-25 13:24:03 +0000 | [diff] [blame] | 2 | # Copyright (c) 2021-2022 Bell Canada. |
JosephKeenan | 909a850 | 2022-01-28 10:02:24 +0000 | [diff] [blame] | 3 | # Modifications Copyright (C) 2021-2022 Nordix Foundation |
rajesh.kumar | cc21a02 | 2022-12-06 11:47:24 +0000 | [diff] [blame] | 4 | # Modifications Copyright (C) 2022-2023 TechMahindra Ltd. |
Michal Jagiello | 6ce84d9 | 2022-12-13 07:40:19 +0000 | [diff] [blame] | 5 | # Modifications Copyright (C) 2022 Deutsche Telekom AG |
shivasubedi | 8df61a9 | 2021-06-16 14:43:18 +0100 | [diff] [blame] | 6 | # ================================================================================ |
| 7 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 8 | # you may not use this file except in compliance with the License. |
| 9 | # You may obtain a copy of the License at |
| 10 | # |
| 11 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 12 | # |
| 13 | # Unless required by applicable law or agreed to in writing, software |
| 14 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 15 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 16 | # See the License for the specific language governing permissions and |
| 17 | # limitations under the License. |
Renu Kumari | 4d52001 | 2021-08-30 11:50:43 -0400 | [diff] [blame] | 18 | # |
| 19 | # SPDX-License-Identifier: Apache-2.0 |
shivasubedi | 8df61a9 | 2021-06-16 14:43:18 +0100 | [diff] [blame] | 20 | # ============LICENSE_END========================================================= |
| 21 | |
puthuparambil.aditya | 001e773 | 2021-01-13 12:06:20 +0000 | [diff] [blame] | 22 | components: |
| 23 | schemas: |
JosephKeenan | c6865f3 | 2021-06-08 13:16:37 +0100 | [diff] [blame] | 24 | |
| 25 | AnchorDetails: |
| 26 | type: object |
| 27 | title: Anchor details by anchor Name |
| 28 | properties: |
| 29 | name: |
| 30 | type: string |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 31 | example: my-anchor |
JosephKeenan | c6865f3 | 2021-06-08 13:16:37 +0100 | [diff] [blame] | 32 | dataspaceName: |
| 33 | type: string |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 34 | example: my-dataspace |
JosephKeenan | c6865f3 | 2021-06-08 13:16:37 +0100 | [diff] [blame] | 35 | schemaSetName: |
| 36 | type: string |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 37 | example: my-schema-set |
JosephKeenan | c6865f3 | 2021-06-08 13:16:37 +0100 | [diff] [blame] | 38 | |
rajesh.kumar | cec0cb7 | 2022-09-06 11:47:18 +0000 | [diff] [blame] | 39 | DataspaceDetails: |
| 40 | type: object |
| 41 | title: Dataspace details by dataspace Name |
| 42 | properties: |
| 43 | name: |
| 44 | type: string |
| 45 | example: my-dataspace |
| 46 | |
puthuparambil.aditya | 001e773 | 2021-01-13 12:06:20 +0000 | [diff] [blame] | 47 | ErrorMessage: |
| 48 | type: object |
| 49 | title: Error |
| 50 | properties: |
| 51 | status: |
| 52 | type: string |
| 53 | message: |
| 54 | type: string |
| 55 | details: |
| 56 | type: string |
Rishi.Chail | 6d13f16 | 2021-01-26 05:58:39 +0000 | [diff] [blame] | 57 | |
puthuparambil.aditya | 001e773 | 2021-01-13 12:06:20 +0000 | [diff] [blame] | 58 | MultipartFile: |
Renu Kumari | 4d52001 | 2021-08-30 11:50:43 -0400 | [diff] [blame] | 59 | type: object |
puthuparambil.aditya | 001e773 | 2021-01-13 12:06:20 +0000 | [diff] [blame] | 60 | required: |
| 61 | - file |
| 62 | properties: |
Renu Kumari | 4d52001 | 2021-08-30 11:50:43 -0400 | [diff] [blame] | 63 | file: |
puthuparambil.aditya | 001e773 | 2021-01-13 12:06:20 +0000 | [diff] [blame] | 64 | type: string |
| 65 | description: multipartFile |
| 66 | format: binary |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 67 | example: 'https://github.com/onap/cps/blob/master/cps-service/src/test/resources/bookstore.yang' |
puthuparambil.aditya | 001e773 | 2021-01-13 12:06:20 +0000 | [diff] [blame] | 68 | |
JosephKeenan | c6865f3 | 2021-06-08 13:16:37 +0100 | [diff] [blame] | 69 | ModuleReferences: |
| 70 | type: object |
| 71 | title: Module reference object |
| 72 | properties: |
| 73 | name: |
| 74 | type: string |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 75 | example: my-module-reference-name |
JosephKeenan | c6865f3 | 2021-06-08 13:16:37 +0100 | [diff] [blame] | 76 | namespace: |
| 77 | type: string |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 78 | example: my-module-reference-namespace |
JosephKeenan | c6865f3 | 2021-06-08 13:16:37 +0100 | [diff] [blame] | 79 | revision: |
| 80 | type: string |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 81 | example: my-module-reference-revision |
JosephKeenan | c6865f3 | 2021-06-08 13:16:37 +0100 | [diff] [blame] | 82 | |
| 83 | SchemaSetDetails: |
| 84 | type: object |
| 85 | title: Schema set details by dataspace and schemasetName |
lukegleeson | d5bda88 | 2022-03-02 14:32:47 +0000 | [diff] [blame] | 86 | required: |
| 87 | - "moduleReferences" |
JosephKeenan | c6865f3 | 2021-06-08 13:16:37 +0100 | [diff] [blame] | 88 | properties: |
| 89 | dataspaceName: |
| 90 | type: string |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 91 | example: my-dataspace |
JosephKeenan | c6865f3 | 2021-06-08 13:16:37 +0100 | [diff] [blame] | 92 | moduleReferences: |
| 93 | type: array |
| 94 | items: |
| 95 | $ref: '#/components/schemas/ModuleReferences' |
| 96 | name: |
| 97 | type: string |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 98 | example: my-schema-set |
| 99 | |
| 100 | examples: |
puthuparambil.aditya | cc17ae5 | 2022-02-25 13:24:03 +0000 | [diff] [blame] | 101 | dataSample: |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 102 | value: |
| 103 | test:bookstore: |
| 104 | bookstore-name: Chapters |
| 105 | categories: |
| 106 | - code: 01 |
| 107 | name: SciFi |
| 108 | - code: 02 |
| 109 | name: kids |
Michal Jagiello | 6ce84d9 | 2022-12-13 07:40:19 +0000 | [diff] [blame] | 110 | dataSampleXml: |
| 111 | value: |
| 112 | <stores xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> |
| 113 | <bookstore xmlns="org:onap:ccsdk:sample"> |
| 114 | <bookstore-name>Chapters</bookstore-name> |
| 115 | <categories> |
| 116 | <code>1</code> |
| 117 | <name>SciFi</name> |
| 118 | </categories> |
| 119 | </bookstore> |
| 120 | </stores> |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 121 | |
puthuparambil.aditya | 001e773 | 2021-01-13 12:06:20 +0000 | [diff] [blame] | 122 | parameters: |
| 123 | dataspaceNameInQuery: |
| 124 | name: dataspace-name |
| 125 | in: query |
| 126 | description: dataspace-name |
| 127 | required: true |
| 128 | schema: |
| 129 | type: string |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 130 | example: my-dataspace |
puthuparambil.aditya | 001e773 | 2021-01-13 12:06:20 +0000 | [diff] [blame] | 131 | dataspaceNameInPath: |
| 132 | name: dataspace-name |
| 133 | in: path |
| 134 | description: dataspace-name |
| 135 | required: true |
| 136 | schema: |
| 137 | type: string |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 138 | example: my-dataspace |
puthuparambil.aditya | 001e773 | 2021-01-13 12:06:20 +0000 | [diff] [blame] | 139 | anchorNameInPath: |
| 140 | name: anchor-name |
| 141 | in: path |
| 142 | description: anchor-name |
| 143 | required: true |
| 144 | schema: |
| 145 | type: string |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 146 | example: my-anchor |
puthuparambil.aditya | 001e773 | 2021-01-13 12:06:20 +0000 | [diff] [blame] | 147 | schemaSetNameInQuery: |
| 148 | name: schema-set-name |
| 149 | in: query |
| 150 | description: schema-set-name |
| 151 | required: true |
| 152 | schema: |
| 153 | type: string |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 154 | example: my-schema-set |
puthuparambil.aditya | 001e773 | 2021-01-13 12:06:20 +0000 | [diff] [blame] | 155 | schemaSetNameInPath: |
| 156 | name: schema-set-name |
| 157 | in: path |
| 158 | description: schema-set-name |
| 159 | required: true |
| 160 | schema: |
| 161 | type: string |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 162 | example: my-schema-set |
puthuparambil.aditya | 001e773 | 2021-01-13 12:06:20 +0000 | [diff] [blame] | 163 | anchorNameInQuery: |
| 164 | name: anchor-name |
| 165 | in: query |
| 166 | description: anchor-name |
| 167 | required: true |
| 168 | schema: |
| 169 | type: string |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 170 | example: my-anchor |
Ruslan Kashapov | 2098392 | 2021-02-01 10:47:25 +0200 | [diff] [blame] | 171 | xpathInQuery: |
Ruslan Kashapov | 24c72db | 2021-02-09 17:25:18 +0200 | [diff] [blame] | 172 | name: xpath |
Ruslan Kashapov | 2098392 | 2021-02-01 10:47:25 +0200 | [diff] [blame] | 173 | in: query |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 174 | description: For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html |
Ruslan Kashapov | 2098392 | 2021-02-01 10:47:25 +0200 | [diff] [blame] | 175 | required: false |
| 176 | schema: |
| 177 | type: string |
| 178 | default: / |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 179 | examples: |
| 180 | container xpath: |
| 181 | value: /shops/bookstore |
| 182 | list attributes xpath: |
| 183 | value: /shops/bookstore/categories[@code=1] |
Ruslan Kashapov | 0905ac1 | 2021-05-05 13:11:50 +0300 | [diff] [blame] | 184 | requiredXpathInQuery: |
| 185 | name: xpath |
| 186 | in: query |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 187 | description: For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html |
Ruslan Kashapov | 0905ac1 | 2021-05-05 13:11:50 +0300 | [diff] [blame] | 188 | required: true |
| 189 | schema: |
| 190 | type: string |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 191 | examples: |
| 192 | container xpath: |
| 193 | value: /shops/bookstore |
| 194 | list attributes xpath: |
| 195 | value: /shops/bookstore/categories[@code=1] |
niamhcore | 53f07ac | 2021-02-19 13:14:40 +0000 | [diff] [blame] | 196 | cpsPathInQuery: |
| 197 | name: cps-path |
| 198 | in: query |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 199 | description: For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html |
niamhcore | 53f07ac | 2021-02-19 13:14:40 +0000 | [diff] [blame] | 200 | required: false |
| 201 | schema: |
| 202 | type: string |
| 203 | default: / |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 204 | examples: |
| 205 | container cps path: |
| 206 | value: //bookstore |
| 207 | list attributes cps path: |
| 208 | value: //categories[@code=1] |
Ruslan Kashapov | 2098392 | 2021-02-01 10:47:25 +0200 | [diff] [blame] | 209 | includeDescendantsOptionInQuery: |
| 210 | name: include-descendants |
| 211 | in: query |
| 212 | description: include-descendants |
| 213 | required: false |
| 214 | schema: |
| 215 | type: boolean |
| 216 | default: false |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 217 | example: false |
aditya puthuparambil | 673c6d9 | 2021-08-24 17:44:34 +0100 | [diff] [blame] | 218 | observedTimestampInQuery: |
| 219 | name: observed-timestamp |
| 220 | in: query |
| 221 | description: observed-timestamp |
| 222 | required: false |
| 223 | schema: |
| 224 | type: string |
| 225 | example: '2021-03-21T00:10:34.030-0100' |
rajesh.kumar | 897686f | 2022-12-14 08:13:29 +0000 | [diff] [blame] | 226 | apiVersionInPath: |
| 227 | name: apiVersion |
| 228 | in: path |
| 229 | description: apiVersion |
| 230 | required: true |
| 231 | schema: |
| 232 | type: string |
| 233 | enum: [v1, v2] |
| 234 | default: v2 |
Michal Jagiello | 6ce84d9 | 2022-12-13 07:40:19 +0000 | [diff] [blame] | 235 | contentTypeHeader: |
| 236 | name: Content-Type |
| 237 | in: header |
| 238 | description: Content type header |
| 239 | schema: |
| 240 | type: string |
| 241 | example: 'application/json' |
| 242 | required: true |
rajesh.kumar | cc21a02 | 2022-12-06 11:47:24 +0000 | [diff] [blame] | 243 | descendantsInQuery: |
| 244 | name: descendants |
| 245 | in: query |
rajesh.kumar | 5d881c3 | 2023-02-03 06:36:40 +0000 | [diff] [blame^] | 246 | description: Number of descendants to query. Allowed values are 'none', 'all', -1 (for all), 0 (for none) and any positive number. |
rajesh.kumar | cc21a02 | 2022-12-06 11:47:24 +0000 | [diff] [blame] | 247 | required: false |
| 248 | schema: |
| 249 | type: string |
| 250 | default: none |
| 251 | example: 3 |
puthuparambil.aditya | 001e773 | 2021-01-13 12:06:20 +0000 | [diff] [blame] | 252 | |
| 253 | responses: |
| 254 | NotFound: |
| 255 | description: The specified resource was not found |
| 256 | content: |
| 257 | application/json: |
| 258 | schema: |
| 259 | $ref: '#/components/schemas/ErrorMessage' |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 260 | example: |
| 261 | status: 404 |
| 262 | message: Resource Not Found |
| 263 | details: The requested resource is not found |
puthuparambil.aditya | 001e773 | 2021-01-13 12:06:20 +0000 | [diff] [blame] | 264 | Unauthorized: |
| 265 | description: Unauthorized |
| 266 | content: |
| 267 | application/json: |
| 268 | schema: |
| 269 | $ref: '#/components/schemas/ErrorMessage' |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 270 | example: |
| 271 | status: 401 |
| 272 | message: Unauthorized request |
| 273 | details: This request is unauthorized |
puthuparambil.aditya | 001e773 | 2021-01-13 12:06:20 +0000 | [diff] [blame] | 274 | Forbidden: |
| 275 | description: Forbidden |
| 276 | content: |
| 277 | application/json: |
| 278 | schema: |
| 279 | $ref: '#/components/schemas/ErrorMessage' |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 280 | example: |
| 281 | status: 403 |
| 282 | message: Request Forbidden |
| 283 | details: This request is forbidden |
puthuparambil.aditya | 001e773 | 2021-01-13 12:06:20 +0000 | [diff] [blame] | 284 | BadRequest: |
| 285 | description: Bad Request |
| 286 | content: |
| 287 | application/json: |
| 288 | schema: |
| 289 | $ref: '#/components/schemas/ErrorMessage' |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 290 | example: |
| 291 | status: 400 |
| 292 | message: Bad Request |
| 293 | details: The provided request is not valid |
Ruslan Kashapov | dce4e31 | 2021-01-11 15:34:10 +0200 | [diff] [blame] | 294 | Conflict: |
| 295 | description: Conflict |
| 296 | content: |
| 297 | application/json: |
| 298 | schema: |
| 299 | $ref: '#/components/schemas/ErrorMessage' |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 300 | example: |
| 301 | status: 409 |
| 302 | message: Conflicting request |
| 303 | details: The request cannot be processed as the resource is in use. |
puthuparambil.aditya | 001e773 | 2021-01-13 12:06:20 +0000 | [diff] [blame] | 304 | Ok: |
| 305 | description: OK |
| 306 | content: |
| 307 | application/json: |
| 308 | schema: |
| 309 | type: object |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 310 | examples: |
puthuparambil.aditya | cc17ae5 | 2022-02-25 13:24:03 +0000 | [diff] [blame] | 311 | dataSample: |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 312 | value: "" |
puthuparambil.aditya | 001e773 | 2021-01-13 12:06:20 +0000 | [diff] [blame] | 313 | Created: |
| 314 | description: Created |
| 315 | content: |
| 316 | text/plain: |
| 317 | schema: |
| 318 | type: string |
puthuparambil.aditya | 5d8b241 | 2021-11-24 13:35:10 +0000 | [diff] [blame] | 319 | example: my-resource |
rajesh.kumar | 897686f | 2022-12-14 08:13:29 +0000 | [diff] [blame] | 320 | CreatedV2: |
| 321 | description: Created without response body |
JosephKeenan | 909a850 | 2022-01-28 10:02:24 +0000 | [diff] [blame] | 322 | InternalServerError: |
| 323 | description: Internal Server Error |
| 324 | content: |
| 325 | application/json: |
| 326 | schema: |
| 327 | $ref: "#/components/schemas/ErrorMessage" |
| 328 | example: |
| 329 | status: 500 |
| 330 | message: Internal Server Error |
| 331 | details: Internal Server Error occurred |
puthuparambil.aditya | 001e773 | 2021-01-13 12:06:20 +0000 | [diff] [blame] | 332 | NoContent: |
| 333 | description: No Content |
| 334 | content: {} |