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:
139 title: Module reference details
143 example: my-module-name
146 example: my-module-revision
148 RestModuleDefinition:
150 title: Module definitions
154 example: my-module-name
163 namespace "org:onap:ccsdk:sample";
165 revision "2020-09-15" {
172 CmHandleQueryParameters:
174 title: Cm Handle query parameters for executing cm handle search
176 cmHandleQueryParameters:
180 $ref: '#/components/schemas/ConditionProperties'
186 $ref: '#/components/schemas/OldConditionProperties'
187 description: not necessary, it is just for backward compatibility
189 cmHandleQueryParameters:
190 - conditionName: hasAllModules
192 - { "moduleName": "my-module-1" }
193 - { "moduleName": "my-module-2" }
194 - { "moduleName": "my-module-3" }
195 - conditionName: hasAllProperties
197 - { "Color": "yellow" }
198 - { "Shape": "circle" }
199 - { "Size": "small" }
208 additionalProperties:
210 OldConditionProperties:
219 $ref: '#/components/schemas/ModuleNameAsJsonObject'
220 ModuleNameAsJsonObject:
228 title: CM handle Details
232 example: my-cm-handle1
233 publicCmHandleProperties:
234 $ref: '#/components/schemas/CmHandlePublicProperties'
236 $ref: '#/components/schemas/CmHandleCompositeState'
237 CmHandlePublicProperties:
241 additionalProperties:
244 CmHandleCompositeState:
251 $ref: '#/components/schemas/lock-reason'
254 example: 2022-12-31T20:30:40.000+0000
259 $ref: '#/components/schemas/dataStores'
266 example: LOCKED_OTHER
269 example: locked due to module sync
275 $ref: '#/components/schemas/sync-state'
277 $ref: '#/components/schemas/sync-state'
284 example: NONE_REQUESTED
287 example: 2022-12-31T20:30:40.000+0000
289 RestOutputCmHandlePublicProperties:
292 publicCmHandleProperties:
293 $ref: '#/components/schemas/CmHandlePublicProperties'
295 RestOutputCmHandleCompositeState:
299 $ref: '#/components/schemas/CmHandleCompositeState'
303 summary: Sample request
304 description: Sample request body
307 bookstore-name: Chapters
321 dataSamplePatchRequest:
322 summary: Sample patch request
323 description: Sample patch request body
325 ietf-restconf:yang-patch:
333 bookstore-name: Chapters
351 bookstore-name: Novels
366 summary: Sample response
367 description: Sample response for selecting 'sample 1'.
387 description: The identifier for a network function, network element, subnetwork or any other cm object by managed Network CM Proxy
391 example: my-cm-handle
400 requiredXpathInQuery:
407 includeDescendantsOptionInQuery:
408 name: include-descendants
410 description: include-descendants
418 description: cps-path
423 resourceIdentifierInQuery:
424 name: resourceIdentifier
426 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.
434 resourceIdentifier: \shops\bookstore
437 resourceIdentifier: \shops\bookstore\categories[@code=1]
440 resourceIdentifier: parent=shops,child=bookstore
444 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.
455 options: (fields=book)
458 options: (depth=2,fields=book/authors)
462 description: topic parameter in query.
471 contentParamInHeader:
475 description: Content parameter for request, if content parameter is null, default value is application/json.
478 default: application/json
479 example: application/yang-data+json
483 description: The specified resource was not found
487 $ref: '#/components/schemas/ErrorMessage'
490 message: Not found error message
491 details: Not found error details
493 description: Unauthorized
497 $ref: '#/components/schemas/ErrorMessage'
500 message: Unauthorized error message
501 details: Unauthorized error details
503 description: Forbidden
507 $ref: '#/components/schemas/ErrorMessage'
510 message: Forbidden error message
511 details: Forbidden error details
513 description: Bad Request
517 $ref: '#/components/schemas/ErrorMessage'
519 status: 400 BAD_REQUEST
520 message: Bad request error message
521 details: Bad request error details
523 description: Conflict
527 $ref: '#/components/schemas/ErrorMessage'
530 message: Conflict error message
531 details: Conflict error details
533 description: The given path has not been implemented
537 $ref: '#/components/schemas/ErrorMessage'
540 message: Not implemented error message
541 details: Not implemented error details
552 description: No Content
555 description: Internal Server Error
559 $ref: "#/components/schemas/ErrorMessage"
562 message: Internal Server Error
563 details: Internal Server Error occurred
565 description: Bad Gateway
569 $ref: "#/components/schemas/DmiErrorMessage"
571 message: "Bad Gateway Error Message NCMP"