1 # ============LICENSE_START=======================================================
2 # Copyright (C) 2021-2022 Nordix Foundation
3 # Modifications Copyright (C) 2021 Pantheon.tech
4 # Modifications Copyright (C) 2022 Bell Canada
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
10 # http://www.apache.org/licenses/LICENSE-2.0
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.
18 # SPDX-License-Identifier: Apache-2.0
19 # ============LICENSE_END=========================================================
34 # DMI Server Exception Schema
36 title: DMI Error Message
41 example: "Bad Gateway Error Message NCMP"
52 RestDmiPluginRegistration:
57 example: my-dmi-plugin
61 example: my-dmi-data-plugin
65 example: my-dmi-model-plugin
70 $ref: '#/components/schemas/RestInputCmHandle'
74 $ref: '#/components/schemas/RestInputCmHandle'
76 cmHandle: my-cm-handle
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: '~'
89 example: [my-cm-handle1, my-cm-handle2, my-cm-handle3]
90 DmiPluginRegistrationErrorResponse:
93 failedCreatedCmHandles:
96 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
97 failedUpdatedCmHandles:
100 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
101 failedRemovedCmHandles:
104 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
105 CmHandlerRegistrationErrorResponse:
110 example: my-cm-handle
116 example: 'Unknown error. <error-details>'
125 example: my-cm-handle
127 $ref: '#/components/schemas/RestCmHandleProperties'
128 publicCmHandleProperties:
129 $ref: '#/components/schemas/RestCmHandleProperties'
130 RestCmHandleProperties:
132 additionalProperties:
140 $ref: '#/components/schemas/ConditionsData'
145 $ref: '#/components/schemas/ConditionProperties'
150 example: hasAllModules
152 $ref: '#/components/schemas/ModuleNamesAsJsonArray'
153 ModuleNamesAsJsonArray:
157 $ref: '#/components/schemas/ModuleNameAsJsonObject'
158 example: [my-module-1, my-module-2, my-module-3]
159 ModuleNameAsJsonObject:
170 $ref: '#/components/schemas/CmHandleProperties'
175 $ref: '#/components/schemas/CmHandleProperty'
180 example: my-cm-handle-id
184 title: Module reference details
188 example: my-module-name
191 example: my-module-revision
193 CmHandleQueryRestParameters:
195 title: Cm Handle query parameters for executing cm handle search
197 publicCmHandleProperties:
199 additionalProperties:
205 title: CM handle Details
209 example: my-cm-handle1
210 publicCmHandleProperties:
211 $ref: '#/components/schemas/CmHandlePublicProperties'
212 CmHandlePublicProperties:
216 additionalProperties:
222 summary: Sample request
223 description: Sample request body
226 bookstore-name: Chapters
240 dataSamplePatchRequest:
241 summary: Sample patch request
242 description: Sample patch request body
244 ietf-restconf:yang-patch:
252 bookstore-name: Chapters
270 bookstore-name: Novels
285 summary: Sample response
286 description: Sample response for selecting 'sample 1'.
306 description: The identifier for a network function, network element, subnetwork or any other cm object by managed Network CM Proxy
310 example: my-cm-handle
319 requiredXpathInQuery:
326 includeDescendantsOptionInQuery:
327 name: include-descendants
329 description: include-descendants
337 description: cps-path
342 resourceIdentifierInQuery:
343 name: resourceIdentifier
345 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.
353 resourceIdentifier: \shops\bookstore
356 resourceIdentifier: \shops\bookstore\categories[@code=1]
359 resourceIdentifier: parent=shops,child=bookstore
363 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.
374 options: (fields=book)
377 options: (depth=2,fields=book/authors)
381 description: topic parameter in query.
390 contentParamInHeader:
394 description: Content parameter for request, if content parameter is null, default value is application/json.
397 default: application/json
398 example: application/yang-data+json
402 description: The specified resource was not found
406 $ref: '#/components/schemas/ErrorMessage'
409 message: Not found error message
410 details: Not found error details
412 description: Unauthorized
416 $ref: '#/components/schemas/ErrorMessage'
419 message: Unauthorized error message
420 details: Unauthorized error details
422 description: Forbidden
426 $ref: '#/components/schemas/ErrorMessage'
429 message: Forbidden error message
430 details: Forbidden error details
432 description: Bad Request
436 $ref: '#/components/schemas/ErrorMessage'
438 status: 400 BAD_REQUEST
439 message: Bad request error message
440 details: Bad request error details
442 description: Conflict
446 $ref: '#/components/schemas/ErrorMessage'
449 message: Conflict error message
450 details: Conflict error details
452 description: The given path has not been implemented
456 $ref: '#/components/schemas/ErrorMessage'
459 message: Not implemented error message
460 details: Not implemented error details
471 description: No Content
474 description: Internal Server Error
478 $ref: "#/components/schemas/ErrorMessage"
481 message: Internal Server Error
482 details: Internal Server Error occurred
484 description: Bad Gateway
488 $ref: "#/components/schemas/DmiErrorMessage"
490 message: "Bad Gateway Error Message NCMP"