1 # ============LICENSE_START=======================================================
2 # Copyright (C) 2021 Bell Canada
3 # Modifications Copyright (C) 2021-2022 Nordix Foundation
4 # ================================================================================
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # SPDX-License-Identifier: Apache-2.0
18 # ============LICENSE_END=========================================================
20 updateDmiRegistration:
22 description: Register a DMI Plugin with any new, updated or removed CM Handles.
24 - network-cm-proxy-inventory
25 summary: DMI notifies NCMP of new CM Handles
26 operationId: updateDmiPluginRegistration
32 $ref: 'components.yaml#/components/schemas/RestDmiPluginRegistration'
35 $ref: 'components.yaml#/components/responses/NoContent'
37 $ref: 'components.yaml#/components/responses/BadRequest'
39 $ref: 'components.yaml#/components/responses/Forbidden'
41 description: Partial or Complete failure. The error details are provided in the response body and all supported error codes are documented in the example.
45 $ref: 'components.yaml#/components/schemas/DmiPluginRegistrationErrorResponse'
47 failedCreatedCmHandles: [
49 "cmHandle": "my-cm-handle-01",
51 "errorText": "Unknown error. <error-details>"
54 "cmHandle": "my-cm-handle-02",
56 "errorText": "cm-handle already exists"
59 "cmHandle": "my-cm-handle-03",
61 "errorText": "cm-handle has an invalid character(s) in id"
64 failedUpdatedCmHandles: [
66 "cmHandle": "my-cm-handle-01",
68 "errorText": "Unknown error. <error-details>"
71 "cmHandle": "my-cm-handle-02",
73 "errorText": "cm-handle does not exist"
76 "cmHandle": "my-cm-handle-03",
78 "errorText": "cm-handle has an invalid character(s) in id"
81 failedRemovedCmHandles: [
83 "cmHandle": "my-cm-handle-01",
85 "errorText": "Unknown error. <error-details>"
88 "cmHandle": "my-cm-handle-02",
90 "errorText": "cm-handle does not exists"
93 "cmHandle": "my-cm-handle-03",
95 "errorText": "cm-handle has an invalid character(s) in id"
99 getAllCmHandleIdsForRegisteredDmi:
101 description: Get all cm handle IDs for a registered DMI plugin
103 - network-cm-proxy-inventory
104 summary: Get all cm handle IDs for a registered DMI plugin (DMI plugin, DMI data plugin, DMI model plugin)
105 operationId: getAllCmHandleIdsForRegisteredDmi
107 - $ref: 'components.yaml#/components/parameters/dmiPluginIdentifierInQuery'
118 $ref: 'components.yaml#/components/responses/Forbidden'
120 $ref: 'components.yaml#/components/responses/InternalServerError'
124 description: Query and get CMHandleIds for additional properties, public properties and registered DMI plugin (DMI plugin, DMI data plugin, DMI model plugin).
126 - network-cm-proxy-inventory
127 summary: Query for CM Handle IDs
128 operationId: searchCmHandleIds
134 $ref: 'components.yaml#/components/schemas/CmHandleQueryParameters'
145 $ref: 'components.yaml#/components/responses/Forbidden'
147 $ref: 'components.yaml#/components/responses/InternalServerError'