tragait | 34a94b9 | 2021-03-30 12:02:27 +0100 | [diff] [blame] | 1 | # ============LICENSE_START======================================================= |
DylanB95EST | 63132ce | 2021-12-14 16:34:38 +0000 | [diff] [blame] | 2 | # Copyright (C) 2021-2022 Nordix Foundation |
Ruslan Kashapov | 1baf48d | 2021-05-07 10:46:27 +0300 | [diff] [blame] | 3 | # Modifications Copyright (C) 2021 Pantheon.tech |
puthuparambil.aditya | d69742c | 2022-03-29 11:03:52 +0100 | [diff] [blame] | 4 | # Modifications Copyright (C) 2022 Bell Canada |
tragait | 34a94b9 | 2021-03-30 12:02:27 +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 |
lukegleeson | 15b93e7 | 2021-07-07 15:25:30 +0100 | [diff] [blame] | 11 | # |
tragait | 34a94b9 | 2021-03-30 12:02:27 +0100 | [diff] [blame] | 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. |
| 17 | # |
| 18 | # SPDX-License-Identifier: Apache-2.0 |
| 19 | # ============LICENSE_END========================================================= |
| 20 | |
Ruslan Kashapov | 9f52f60 | 2021-01-22 12:53:01 +0200 | [diff] [blame] | 21 | components: |
| 22 | schemas: |
niamhcore | 66017b4 | 2021-10-19 11:07:02 +0100 | [diff] [blame] | 23 | # Common Schemas |
Ruslan Kashapov | 9f52f60 | 2021-01-22 12:53:01 +0200 | [diff] [blame] | 24 | ErrorMessage: |
| 25 | type: object |
| 26 | title: Error |
| 27 | properties: |
| 28 | status: |
| 29 | type: string |
| 30 | message: |
| 31 | type: string |
| 32 | details: |
| 33 | type: string |
mpriyank | 93afc1e | 2022-03-28 15:47:47 +0530 | [diff] [blame] | 34 | # DMI Server Exception Schema |
| 35 | DmiErrorMessage: |
| 36 | title: DMI Error Message |
| 37 | type: object |
| 38 | properties: |
| 39 | message: |
| 40 | type: string |
| 41 | example: "Bad Gateway Error Message NCMP" |
| 42 | dmi-response: |
| 43 | type: object |
| 44 | properties: |
| 45 | http-code: |
| 46 | type: integer |
| 47 | example: 400 |
| 48 | body: |
| 49 | type: string |
| 50 | example: Bad Request |
niamhcore | 66017b4 | 2021-10-19 11:07:02 +0100 | [diff] [blame] | 51 | # Request Schemas |
DylanB95EST | 4f4178c | 2021-07-02 13:30:42 +0100 | [diff] [blame] | 52 | RestDmiPluginRegistration: |
| 53 | type: object |
Ruslan Kashapov | 9f52f60 | 2021-01-22 12:53:01 +0200 | [diff] [blame] | 54 | properties: |
DylanB95EST | 4f4178c | 2021-07-02 13:30:42 +0100 | [diff] [blame] | 55 | dmiPlugin: |
Ruslan Kashapov | 9f52f60 | 2021-01-22 12:53:01 +0200 | [diff] [blame] | 56 | type: string |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 57 | example: my-dmi-plugin |
DylanB95EST | d042fcd | 2022-02-21 12:57:08 +0000 | [diff] [blame] | 58 | default: "" |
JosephKeenan | 20b4f9c | 2021-11-23 12:18:28 +0000 | [diff] [blame] | 59 | dmiDataPlugin: |
| 60 | type: string |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 61 | example: my-dmi-data-plugin |
DylanB95EST | d042fcd | 2022-02-21 12:57:08 +0000 | [diff] [blame] | 62 | default: "" |
JosephKeenan | 20b4f9c | 2021-11-23 12:18:28 +0000 | [diff] [blame] | 63 | dmiModelPlugin: |
| 64 | type: string |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 65 | example: my-dmi-model-plugin |
DylanB95EST | d042fcd | 2022-02-21 12:57:08 +0000 | [diff] [blame] | 66 | default: "" |
DylanB95EST | 4f4178c | 2021-07-02 13:30:42 +0100 | [diff] [blame] | 67 | createdCmHandles: |
| 68 | type: array |
| 69 | items: |
DylanB95EST | e557338 | 2022-01-27 17:12:52 +0000 | [diff] [blame] | 70 | $ref: '#/components/schemas/RestInputCmHandle' |
DylanB95EST | 31facc8 | 2021-08-18 17:12:25 +0100 | [diff] [blame] | 71 | updatedCmHandles: |
| 72 | type: array |
| 73 | items: |
DylanB95EST | e557338 | 2022-01-27 17:12:52 +0000 | [diff] [blame] | 74 | $ref: '#/components/schemas/RestInputCmHandle' |
Renu Kumari | 2c96317 | 2022-03-10 16:02:55 -0500 | [diff] [blame] | 75 | example: |
| 76 | cmHandle: my-cm-handle |
| 77 | cmHandleProperties: |
| 78 | add-my-property: add-property |
| 79 | update-my-property: updated-property |
| 80 | delete-my-property: '~' |
| 81 | publicCmHandleProperties: |
| 82 | add-my-property: add-property |
| 83 | update-my-property: updated-property |
| 84 | delete-my-property: '~' |
DylanB95EST | e999b02 | 2021-08-24 16:56:40 +0100 | [diff] [blame] | 85 | removedCmHandles: |
| 86 | type: array |
| 87 | items: |
| 88 | type: string |
bmiklos | bbaf501 | 2022-08-25 18:28:16 +0200 | [diff] [blame] | 89 | example: [ my-cm-handle1, my-cm-handle2, my-cm-handle3 ] |
Renu Kumari | b14f04b | 2022-03-28 10:22:41 -0400 | [diff] [blame] | 90 | DmiPluginRegistrationErrorResponse: |
| 91 | type: object |
| 92 | properties: |
| 93 | failedCreatedCmHandles: |
| 94 | type: array |
| 95 | items: |
| 96 | $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse' |
Renu Kumari | b14f04b | 2022-03-28 10:22:41 -0400 | [diff] [blame] | 97 | failedUpdatedCmHandles: |
| 98 | type: array |
| 99 | items: |
| 100 | $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse' |
Renu Kumari | b14f04b | 2022-03-28 10:22:41 -0400 | [diff] [blame] | 101 | failedRemovedCmHandles: |
| 102 | type: array |
| 103 | items: |
| 104 | $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse' |
Renu Kumari | b14f04b | 2022-03-28 10:22:41 -0400 | [diff] [blame] | 105 | CmHandlerRegistrationErrorResponse: |
| 106 | type: object |
| 107 | properties: |
| 108 | cmHandle: |
| 109 | type: string |
| 110 | example: my-cm-handle |
| 111 | errorCode: |
| 112 | type: string |
Renu Kumari | 952603c | 2022-04-18 12:39:33 -0400 | [diff] [blame] | 113 | example: '00' |
Renu Kumari | b14f04b | 2022-03-28 10:22:41 -0400 | [diff] [blame] | 114 | errorText: |
| 115 | type: string |
Renu Kumari | 952603c | 2022-04-18 12:39:33 -0400 | [diff] [blame] | 116 | example: 'Unknown error. <error-details>' |
DylanB95EST | 4f4178c | 2021-07-02 13:30:42 +0100 | [diff] [blame] | 117 | |
DylanB95EST | e557338 | 2022-01-27 17:12:52 +0000 | [diff] [blame] | 118 | RestInputCmHandle: |
DylanB95EST | 4f4178c | 2021-07-02 13:30:42 +0100 | [diff] [blame] | 119 | required: |
| 120 | - cmHandle |
| 121 | type: object |
| 122 | properties: |
| 123 | cmHandle: |
| 124 | type: string |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 125 | example: my-cm-handle |
DylanB95EST | 4f4178c | 2021-07-02 13:30:42 +0100 | [diff] [blame] | 126 | cmHandleProperties: |
bmiklos | bbaf501 | 2022-08-25 18:28:16 +0200 | [diff] [blame] | 127 | $ref: '#/components/schemas/RestCmHandleProperties' |
DylanB95EST | 63132ce | 2021-12-14 16:34:38 +0000 | [diff] [blame] | 128 | publicCmHandleProperties: |
bmiklos | bbaf501 | 2022-08-25 18:28:16 +0200 | [diff] [blame] | 129 | $ref: '#/components/schemas/RestCmHandleProperties' |
DylanB95EST | 63132ce | 2021-12-14 16:34:38 +0000 | [diff] [blame] | 130 | RestCmHandleProperties: |
bmiklos | bbaf501 | 2022-08-25 18:28:16 +0200 | [diff] [blame] | 131 | type: object |
| 132 | additionalProperties: |
| 133 | type: string |
| 134 | example: my-property |
Ruslan Kashapov | 9f52f60 | 2021-01-22 12:53:01 +0200 | [diff] [blame] | 135 | |
niamhcore | 66017b4 | 2021-10-19 11:07:02 +0100 | [diff] [blame] | 136 | #Response Schemas |
lukegleeson | d5bda88 | 2022-03-02 14:32:47 +0000 | [diff] [blame] | 137 | RestModuleReference: |
puthuparambil.aditya | d000733 | 2021-12-08 18:53:39 +0000 | [diff] [blame] | 138 | type: object |
| 139 | title: Module reference details |
| 140 | properties: |
| 141 | moduleName: |
| 142 | type: string |
| 143 | example: my-module-name |
| 144 | revision: |
| 145 | type: string |
| 146 | example: my-module-revision |
| 147 | |
emaclee | e1f73e2 | 2022-06-17 17:42:56 +0100 | [diff] [blame] | 148 | RestModuleDefinition: |
| 149 | type: object |
| 150 | title: Module definitions |
| 151 | properties: |
| 152 | moduleName: |
| 153 | type: string |
| 154 | example: my-module-name |
| 155 | revision: |
| 156 | type: string |
| 157 | example: 2020-09-15 |
| 158 | content: |
| 159 | type: string |
| 160 | example: | |
| 161 | module stores { |
| 162 | yang-version 1.1; |
| 163 | namespace "org:onap:ccsdk:sample"; |
| 164 | prefix book-store; |
| 165 | revision "2020-09-15" { |
| 166 | description |
| 167 | "Sample Model"; |
| 168 | } |
| 169 | } |
| 170 | |
kissand | e9ed581 | 2022-05-12 15:59:18 +0200 | [diff] [blame] | 171 | CmHandleQueryParameters: |
JosephKeenan | deac477 | 2022-03-28 12:26:07 +0100 | [diff] [blame] | 172 | type: object |
| 173 | title: Cm Handle query parameters for executing cm handle search |
| 174 | properties: |
kissand | e9ed581 | 2022-05-12 15:59:18 +0200 | [diff] [blame] | 175 | cmHandleQueryParameters: |
| 176 | type: array |
| 177 | items: |
| 178 | type: object |
| 179 | $ref: '#/components/schemas/ConditionProperties' |
| 180 | conditions: |
| 181 | deprecated: true |
| 182 | type: array |
| 183 | items: |
| 184 | type: object |
| 185 | $ref: '#/components/schemas/OldConditionProperties' |
| 186 | description: not necessary, it is just for backward compatibility |
lukegleeson | 82a550f | 2022-07-11 10:55:53 +0100 | [diff] [blame] | 187 | |
kissand | e9ed581 | 2022-05-12 15:59:18 +0200 | [diff] [blame] | 188 | ConditionProperties: |
| 189 | properties: |
| 190 | conditionName: |
| 191 | type: string |
| 192 | conditionParameters: |
| 193 | type: array |
| 194 | items: |
| 195 | type: object |
| 196 | additionalProperties: |
| 197 | type: string |
| 198 | OldConditionProperties: |
| 199 | deprecated: true |
| 200 | properties: |
| 201 | name: |
| 202 | type: string |
| 203 | conditionParameters: |
| 204 | type: array |
| 205 | items: |
| 206 | type: object |
| 207 | $ref: '#/components/schemas/ModuleNameAsJsonObject' |
| 208 | ModuleNameAsJsonObject: |
| 209 | properties: |
| 210 | moduleName: |
| 211 | type: string |
| 212 | example: my-module |
JosephKeenan | deac477 | 2022-03-28 12:26:07 +0100 | [diff] [blame] | 213 | |
DylanB95EST | e557338 | 2022-01-27 17:12:52 +0000 | [diff] [blame] | 214 | RestOutputCmHandle: |
| 215 | type: object |
| 216 | title: CM handle Details |
| 217 | properties: |
| 218 | cmHandle: |
| 219 | type: string |
| 220 | example: my-cm-handle1 |
| 221 | publicCmHandleProperties: |
| 222 | $ref: '#/components/schemas/CmHandlePublicProperties' |
mpriyank | 4cf4962 | 2022-05-20 15:25:15 +0100 | [diff] [blame] | 223 | state: |
lukegleeson | 78062a1 | 2022-06-02 10:56:43 +0100 | [diff] [blame] | 224 | $ref: '#/components/schemas/CmHandleCompositeState' |
DylanB95EST | e557338 | 2022-01-27 17:12:52 +0000 | [diff] [blame] | 225 | CmHandlePublicProperties: |
| 226 | type: array |
| 227 | items: |
| 228 | type: object |
| 229 | additionalProperties: |
| 230 | type: string |
| 231 | example: Book Type |
lukegleeson | 78062a1 | 2022-06-02 10:56:43 +0100 | [diff] [blame] | 232 | CmHandleCompositeState: |
mpriyank | 4cf4962 | 2022-05-20 15:25:15 +0100 | [diff] [blame] | 233 | type: object |
| 234 | properties: |
| 235 | cmHandleState: |
| 236 | type: string |
| 237 | example: ADVISED |
| 238 | lockReason: |
| 239 | $ref: '#/components/schemas/lock-reason' |
| 240 | lastUpdateTime: |
| 241 | type: string |
| 242 | example: 2022-12-31T20:30:40.000+0000 |
| 243 | dataSyncEnabled: |
| 244 | type: boolean |
| 245 | example: false |
| 246 | dataSyncState: |
| 247 | $ref: '#/components/schemas/dataStores' |
| 248 | |
| 249 | lock-reason: |
| 250 | type: object |
| 251 | properties: |
| 252 | reason: |
| 253 | type: string |
lukegleeson | 4e59684 | 2022-06-28 12:15:33 +0100 | [diff] [blame] | 254 | example: LOCKED_MISBEHAVING |
mpriyank | 4cf4962 | 2022-05-20 15:25:15 +0100 | [diff] [blame] | 255 | details: |
| 256 | type: string |
lukegleeson | 4e59684 | 2022-06-28 12:15:33 +0100 | [diff] [blame] | 257 | example: locked due to failure in module sync |
mpriyank | 4cf4962 | 2022-05-20 15:25:15 +0100 | [diff] [blame] | 258 | |
| 259 | dataStores: |
| 260 | type: object |
| 261 | properties: |
| 262 | operational: |
| 263 | $ref: '#/components/schemas/sync-state' |
| 264 | running: |
| 265 | $ref: '#/components/schemas/sync-state' |
| 266 | |
| 267 | sync-state: |
| 268 | type: object |
| 269 | properties: |
lukegleeson | 82a550f | 2022-07-11 10:55:53 +0100 | [diff] [blame] | 270 | syncState: |
mpriyank | 4cf4962 | 2022-05-20 15:25:15 +0100 | [diff] [blame] | 271 | type: string |
| 272 | example: NONE_REQUESTED |
| 273 | lastSyncTime: |
| 274 | type: string |
| 275 | example: 2022-12-31T20:30:40.000+0000 |
DylanB95EST | e557338 | 2022-01-27 17:12:52 +0000 | [diff] [blame] | 276 | |
lukegleeson | bed18fd | 2022-05-06 12:02:42 +0100 | [diff] [blame] | 277 | RestOutputCmHandlePublicProperties: |
| 278 | type: object |
| 279 | properties: |
| 280 | publicCmHandleProperties: |
| 281 | $ref: '#/components/schemas/CmHandlePublicProperties' |
| 282 | |
lukegleeson | 78062a1 | 2022-06-02 10:56:43 +0100 | [diff] [blame] | 283 | RestOutputCmHandleCompositeState: |
| 284 | type: object |
| 285 | properties: |
| 286 | state: |
| 287 | $ref: '#/components/schemas/CmHandleCompositeState' |
| 288 | |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 289 | examples: |
| 290 | dataSampleRequest: |
bmiklos | bbaf501 | 2022-08-25 18:28:16 +0200 | [diff] [blame] | 291 | summary: Sample request |
| 292 | description: Sample request body |
| 293 | value: |
| 294 | test:bookstore: |
| 295 | bookstore-name: Chapters |
| 296 | categories: |
| 297 | - code: '01' |
| 298 | name: SciFi |
| 299 | books: |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 300 | - authors: |
| 301 | - Iain M. Banks |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 302 | - Ursula K. Le Guin |
bmiklos | bbaf501 | 2022-08-25 18:28:16 +0200 | [diff] [blame] | 303 | - code: '02' |
| 304 | name: kids |
| 305 | books: |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 306 | - authors: |
| 307 | - Philip Pullman |
| 308 | |
tragait | ecd7f5e | 2022-01-13 13:15:14 +0000 | [diff] [blame] | 309 | dataSamplePatchRequest: |
| 310 | summary: Sample patch request |
| 311 | description: Sample patch request body |
| 312 | value: |
| 313 | ietf-restconf:yang-patch: |
| 314 | patch-id: patch-1 |
| 315 | edit: |
| 316 | - edit-id: edit1 |
| 317 | operation: merge |
| 318 | target: / |
| 319 | value: |
| 320 | test:bookstore: |
| 321 | bookstore-name: Chapters |
| 322 | categories: |
| 323 | - code: '01' |
| 324 | name: Science |
| 325 | books: |
| 326 | - authors: |
| 327 | - Author1 |
| 328 | - Author2 |
| 329 | - code: '02' |
| 330 | name: Arts |
| 331 | books: |
| 332 | - authors: |
| 333 | - Author3 |
| 334 | - edit-id: edit2 |
| 335 | operation: merge |
| 336 | target: / |
| 337 | value: |
| 338 | test:bookstore: |
| 339 | bookstore-name: Novels |
| 340 | categories: |
| 341 | - code: '03' |
| 342 | name: History |
| 343 | books: |
| 344 | - authors: |
| 345 | - Iain M. Banks |
| 346 | - Ursula K. Le Guin |
| 347 | - code: '04' |
| 348 | name: Fiction |
| 349 | books: |
| 350 | - authors: |
| 351 | - Philip Pullman |
| 352 | |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 353 | dataSampleResponse: |
bmiklos | bbaf501 | 2022-08-25 18:28:16 +0200 | [diff] [blame] | 354 | summary: Sample response |
| 355 | description: Sample response for selecting 'sample 1'. |
| 356 | value: |
| 357 | bookstore: |
| 358 | categories: |
| 359 | - code: '01' |
| 360 | books: |
| 361 | - authors: |
| 362 | - Iain M. Banks |
| 363 | - Ursula K. Le Guin |
| 364 | name: SciFi |
| 365 | - code: '02' |
| 366 | books: |
| 367 | - authors: |
| 368 | - Philip Pullman |
| 369 | name: kids |
niamhcore | 66017b4 | 2021-10-19 11:07:02 +0100 | [diff] [blame] | 370 | |
lukegleeson | 82a550f | 2022-07-11 10:55:53 +0100 | [diff] [blame] | 371 | allCmHandleQueryParameters: |
| 372 | value: |
| 373 | cmHandleQueryParameters: |
| 374 | - conditionName: hasAllModules |
| 375 | conditionParameters: |
| 376 | - { "moduleName": "my-module-1" } |
| 377 | - { "moduleName": "my-module-2" } |
| 378 | - { "moduleName": "my-module-3" } |
| 379 | - conditionName: hasAllProperties |
| 380 | conditionParameters: |
| 381 | - { "Color": "yellow" } |
| 382 | - { "Shape": "circle" } |
| 383 | - { "Size": "small" } |
| 384 | - conditionName: cmHandleWithCpsPath |
| 385 | conditionParameters: |
| 386 | - { "cpsPath": "//state[@cm-handle-state='ADVISED']" } |
| 387 | pubPropCmHandleQueryParameters: |
| 388 | value: |
| 389 | cmHandleQueryParameters: |
| 390 | - conditionName: hasAllProperties |
| 391 | conditionParameters: |
| 392 | - { "Color": "yellow" } |
| 393 | - { "Shape": "circle" } |
| 394 | - { "Size": "small" } |
| 395 | modulesCmHandleQueryParameters: |
| 396 | value: |
| 397 | cmHandleQueryParameters: |
| 398 | - conditionName: hasAllModules |
| 399 | conditionParameters: |
| 400 | - { "moduleName": "my-module-1" } |
| 401 | - { "moduleName": "my-module-2" } |
| 402 | - { "moduleName": "my-module-3" } |
| 403 | cpsPathCmHandleStateQueryParameters: |
| 404 | value: |
| 405 | cmHandleQueryParameters: |
| 406 | - conditionName: cmHandleWithCpsPath |
| 407 | conditionParameters: |
| 408 | - { "cpsPath": "//state[@cm-handle-state='LOCKED']" } |
| 409 | cpsPathCmHandleDataSyncQueryParameters: |
| 410 | value: |
| 411 | cmHandleQueryParameters: |
| 412 | - conditionName: cmHandleWithCpsPath |
| 413 | conditionParameters: |
| 414 | - { "cpsPath": "//state[@data-sync-enabled='true']" } |
| 415 | |
Ruslan Kashapov | 9f52f60 | 2021-01-22 12:53:01 +0200 | [diff] [blame] | 416 | parameters: |
Hanif Kukkalli | 83e318f | 2021-02-23 12:26:39 +0100 | [diff] [blame] | 417 | cmHandleInPath: |
| 418 | name: cm-handle |
| 419 | in: path |
tragait | 34a94b9 | 2021-03-30 12:02:27 +0100 | [diff] [blame] | 420 | description: The identifier for a network function, network element, subnetwork or any other cm object by managed Network CM Proxy |
Hanif Kukkalli | 83e318f | 2021-02-23 12:26:39 +0100 | [diff] [blame] | 421 | required: true |
| 422 | schema: |
| 423 | type: string |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 424 | example: my-cm-handle |
DylanB95EST | 6ddbe4a | 2022-07-19 11:36:10 +0100 | [diff] [blame] | 425 | dataSyncEnabled: |
| 426 | name: dataSyncEnabled |
| 427 | in: query |
| 428 | description: Is used to enable or disable the data synchronization flag |
| 429 | required: true |
| 430 | schema: |
| 431 | type: boolean |
| 432 | example: true |
Hanif Kukkalli | 83e318f | 2021-02-23 12:26:39 +0100 | [diff] [blame] | 433 | xpathInQuery: |
| 434 | name: xpath |
| 435 | in: query |
| 436 | description: xpath |
| 437 | required: false |
| 438 | schema: |
| 439 | type: string |
| 440 | default: / |
Ruslan Kashapov | 1baf48d | 2021-05-07 10:46:27 +0300 | [diff] [blame] | 441 | requiredXpathInQuery: |
| 442 | name: xpath |
| 443 | in: query |
| 444 | description: xpath |
| 445 | required: true |
| 446 | schema: |
| 447 | type: string |
Hanif Kukkalli | 83e318f | 2021-02-23 12:26:39 +0100 | [diff] [blame] | 448 | includeDescendantsOptionInQuery: |
| 449 | name: include-descendants |
| 450 | in: query |
bmiklos | bbaf501 | 2022-08-25 18:28:16 +0200 | [diff] [blame] | 451 | description: Determines if descendants are included in response |
Hanif Kukkalli | 83e318f | 2021-02-23 12:26:39 +0100 | [diff] [blame] | 452 | required: false |
| 453 | schema: |
| 454 | type: boolean |
| 455 | default: false |
niamhcore | b5d573b | 2021-02-26 10:13:48 +0000 | [diff] [blame] | 456 | cpsPathInQuery: |
| 457 | name: cps-path |
| 458 | in: query |
lukegleeson | 20e7a73 | 2022-10-20 10:14:00 +0100 | [diff] [blame] | 459 | description: For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html |
niamhcore | b5d573b | 2021-02-26 10:13:48 +0000 | [diff] [blame] | 460 | required: false |
| 461 | schema: |
| 462 | type: string |
| 463 | default: / |
lukegleeson | 20e7a73 | 2022-10-20 10:14:00 +0100 | [diff] [blame] | 464 | examples: |
| 465 | container cps path: |
| 466 | value: //bookstore |
| 467 | list attributes cps path: |
| 468 | value: //categories[@code=1] |
emaclee | d340047 | 2022-08-19 09:26:39 +0100 | [diff] [blame] | 469 | dmiPluginIdentifierInQuery: |
| 470 | name: dmi-plugin-identifier |
| 471 | in: query |
| 472 | description: dmi-plugin-identifier |
| 473 | required: true |
| 474 | schema: |
| 475 | type: string |
| 476 | example: my-dmi-plugin |
niamhcore | fd2e6dd | 2021-09-29 16:43:35 +0100 | [diff] [blame] | 477 | resourceIdentifierInQuery: |
tragait | c328551 | 2021-08-16 15:12:36 +0100 | [diff] [blame] | 478 | name: resourceIdentifier |
niamhcore | fd2e6dd | 2021-09-29 16:43:35 +0100 | [diff] [blame] | 479 | in: query |
| 480 | description: The format of resource identifier depend on the associated DMI Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but it can really be anything. |
tragait | c328551 | 2021-08-16 15:12:36 +0100 | [diff] [blame] | 481 | required: true |
niamhcore | fd2e6dd | 2021-09-29 16:43:35 +0100 | [diff] [blame] | 482 | allowReserved: true |
tragait | c328551 | 2021-08-16 15:12:36 +0100 | [diff] [blame] | 483 | schema: |
| 484 | type: string |
niamhcore | fd2e6dd | 2021-09-29 16:43:35 +0100 | [diff] [blame] | 485 | examples: |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 486 | sample 1: |
niamhcore | fd2e6dd | 2021-09-29 16:43:35 +0100 | [diff] [blame] | 487 | value: |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 488 | resourceIdentifier: \shops\bookstore |
| 489 | sample 2: |
niamhcore | fd2e6dd | 2021-09-29 16:43:35 +0100 | [diff] [blame] | 490 | value: |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 491 | resourceIdentifier: \shops\bookstore\categories[@code=1] |
| 492 | sample 3: |
niamhcore | fd2e6dd | 2021-09-29 16:43:35 +0100 | [diff] [blame] | 493 | value: |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 494 | resourceIdentifier: parent=shops,child=bookstore |
tragait | abdff1b | 2021-10-06 11:04:18 +0100 | [diff] [blame] | 495 | optionsParamInQuery: |
| 496 | name: options |
tragait | c328551 | 2021-08-16 15:12:36 +0100 | [diff] [blame] | 497 | in: query |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 498 | description: options parameter in query, it is mandatory to wrap key(s)=value(s) in parenthesis'()'. The format of options parameter depend on the associated DMI Plugin implementation. |
tragait | c328551 | 2021-08-16 15:12:36 +0100 | [diff] [blame] | 499 | required: false |
| 500 | schema: |
| 501 | type: string |
tragait | abdff1b | 2021-10-06 11:04:18 +0100 | [diff] [blame] | 502 | allowReserved: true |
| 503 | examples: |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 504 | sample 1: |
tragait | abdff1b | 2021-10-06 11:04:18 +0100 | [diff] [blame] | 505 | value: |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 506 | options: (depth=3) |
| 507 | sample 2: |
tragait | abdff1b | 2021-10-06 11:04:18 +0100 | [diff] [blame] | 508 | value: |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 509 | options: (fields=book) |
| 510 | sample 3: |
tragait | abdff1b | 2021-10-06 11:04:18 +0100 | [diff] [blame] | 511 | value: |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 512 | options: (depth=2,fields=book/authors) |
sourabh_sourabh | 1f2e66e | 2022-02-16 21:53:41 +0530 | [diff] [blame] | 513 | topicParamInQuery: |
| 514 | name: topic |
| 515 | in: query |
| 516 | description: topic parameter in query. |
| 517 | required: false |
| 518 | schema: |
| 519 | type: string |
| 520 | allowReserved: true |
| 521 | examples: |
| 522 | sample 1: |
| 523 | value: |
| 524 | topic: my-topic-name |
tragait | c584bf2 | 2021-08-20 15:45:58 +0100 | [diff] [blame] | 525 | contentParamInHeader: |
| 526 | name: Content-Type |
| 527 | in: header |
| 528 | required: false |
| 529 | description: Content parameter for request, if content parameter is null, default value is application/json. |
| 530 | schema: |
| 531 | type: string |
| 532 | default: application/json |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 533 | example: application/yang-data+json |
bmiklos | bbaf501 | 2022-08-25 18:28:16 +0200 | [diff] [blame] | 534 | datastoreName: |
lukegleeson | 20e7a73 | 2022-10-20 10:14:00 +0100 | [diff] [blame] | 535 | name: datastore-name |
bmiklos | bbaf501 | 2022-08-25 18:28:16 +0200 | [diff] [blame] | 536 | in: path |
| 537 | description: The type of the requested data |
| 538 | required: true |
| 539 | schema: |
| 540 | type: string |
seanbeirne | afc6055 | 2023-01-30 16:53:37 +0000 | [diff] [blame^] | 541 | example: ncmp-datastore:running |
Ruslan Kashapov | 9f52f60 | 2021-01-22 12:53:01 +0200 | [diff] [blame] | 542 | |
| 543 | responses: |
| 544 | NotFound: |
| 545 | description: The specified resource was not found |
| 546 | content: |
| 547 | application/json: |
| 548 | schema: |
| 549 | $ref: '#/components/schemas/ErrorMessage' |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 550 | example: |
| 551 | status: 400 |
| 552 | message: Not found error message |
| 553 | details: Not found error details |
Ruslan Kashapov | 9f52f60 | 2021-01-22 12:53:01 +0200 | [diff] [blame] | 554 | Unauthorized: |
| 555 | description: Unauthorized |
| 556 | content: |
| 557 | application/json: |
| 558 | schema: |
| 559 | $ref: '#/components/schemas/ErrorMessage' |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 560 | example: |
| 561 | status: 401 |
| 562 | message: Unauthorized error message |
| 563 | details: Unauthorized error details |
Ruslan Kashapov | 9f52f60 | 2021-01-22 12:53:01 +0200 | [diff] [blame] | 564 | Forbidden: |
| 565 | description: Forbidden |
| 566 | content: |
| 567 | application/json: |
| 568 | schema: |
| 569 | $ref: '#/components/schemas/ErrorMessage' |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 570 | example: |
bmiklos | bbaf501 | 2022-08-25 18:28:16 +0200 | [diff] [blame] | 571 | status: 403 |
| 572 | message: Forbidden error message |
| 573 | details: Forbidden error details |
Ruslan Kashapov | 9f52f60 | 2021-01-22 12:53:01 +0200 | [diff] [blame] | 574 | BadRequest: |
| 575 | description: Bad Request |
| 576 | content: |
| 577 | application/json: |
| 578 | schema: |
| 579 | $ref: '#/components/schemas/ErrorMessage' |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 580 | example: |
bmiklos | bbaf501 | 2022-08-25 18:28:16 +0200 | [diff] [blame] | 581 | status: 400 BAD_REQUEST |
| 582 | message: Bad request error message |
| 583 | details: Bad request error details |
Ruslan Kashapov | 9f52f60 | 2021-01-22 12:53:01 +0200 | [diff] [blame] | 584 | Conflict: |
| 585 | description: Conflict |
| 586 | content: |
| 587 | application/json: |
| 588 | schema: |
| 589 | $ref: '#/components/schemas/ErrorMessage' |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 590 | example: |
bmiklos | bbaf501 | 2022-08-25 18:28:16 +0200 | [diff] [blame] | 591 | status: 409 CONFLICT |
| 592 | message: Conflict error message |
| 593 | details: Conflict error details |
Hanif Kukkalli | 83e318f | 2021-02-23 12:26:39 +0100 | [diff] [blame] | 594 | NotImplemented: |
| 595 | description: The given path has not been implemented |
| 596 | content: |
| 597 | application/json: |
| 598 | schema: |
| 599 | $ref: '#/components/schemas/ErrorMessage' |
emaclee | 844cab3 | 2021-12-01 09:42:37 +0000 | [diff] [blame] | 600 | example: |
bmiklos | bbaf501 | 2022-08-25 18:28:16 +0200 | [diff] [blame] | 601 | status: 501 |
| 602 | message: Not implemented error message |
| 603 | details: Not implemented error details |
Ruslan Kashapov | 9f52f60 | 2021-01-22 12:53:01 +0200 | [diff] [blame] | 604 | Ok: |
| 605 | description: OK |
| 606 | content: |
| 607 | application/json: |
| 608 | schema: |
| 609 | type: object |
| 610 | Created: |
| 611 | description: Created |
bmiklos | bbaf501 | 2022-08-25 18:28:16 +0200 | [diff] [blame] | 612 | content: { } |
Ruslan Kashapov | 9f52f60 | 2021-01-22 12:53:01 +0200 | [diff] [blame] | 613 | NoContent: |
| 614 | description: No Content |
bmiklos | bbaf501 | 2022-08-25 18:28:16 +0200 | [diff] [blame] | 615 | content: { } |
JosephKeenan | e0873dd | 2022-01-28 11:22:22 +0000 | [diff] [blame] | 616 | InternalServerError: |
| 617 | description: Internal Server Error |
| 618 | content: |
| 619 | application/json: |
| 620 | schema: |
| 621 | $ref: "#/components/schemas/ErrorMessage" |
| 622 | example: |
| 623 | status: 500 |
| 624 | message: Internal Server Error |
| 625 | details: Internal Server Error occurred |
mpriyank | 93afc1e | 2022-03-28 15:47:47 +0530 | [diff] [blame] | 626 | BadGateway: |
| 627 | description: Bad Gateway |
| 628 | content: |
| 629 | application/json: |
| 630 | schema: |
| 631 | $ref: "#/components/schemas/DmiErrorMessage" |
| 632 | example: |
| 633 | message: "Bad Gateway Error Message NCMP" |
| 634 | dmi-response: |
| 635 | http-code: 400 |
| 636 | body: "Bad Request" |