1 # ============LICENSE_START=======================================================
2 # Copyright (C) 2021 Nordix Foundation
3 # Modifications Copyright (C) 2021 Pantheon.tech
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 nodeByCmHandleAndXpath:
22 description: Get a node with an option to retrieve all the children for a given cm Handle
26 summary: Get a node given a cm Handle and xpath
27 operationId: getNodeByCmHandleAndXpath
29 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
30 - $ref: 'components.yaml#/components/parameters/xpathInQuery'
31 - $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
34 $ref: 'components.yaml#/components/responses/Ok'
36 $ref: 'components.yaml#/components/responses/BadRequest'
38 $ref: 'components.yaml#/components/responses/Unauthorized'
40 $ref: 'components.yaml#/components/responses/Forbidden'
42 $ref: 'components.yaml#/components/responses/NotFound'
44 nodesByCmHandleAndCpsPath:
46 description: Query nodes for the given cps path and cm Handle
50 summary: Query data nodes
51 operationId: queryNodesByCmHandleAndCpsPath
53 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
54 - $ref: 'components.yaml#/components/parameters/cpsPathInQuery'
55 - $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
58 $ref: 'components.yaml#/components/responses/Ok'
60 $ref: 'components.yaml#/components/responses/BadRequest'
62 $ref: 'components.yaml#/components/responses/Unauthorized'
64 $ref: 'components.yaml#/components/responses/Forbidden'
66 $ref: 'components.yaml#/components/responses/NotFound'
68 nodesByCmHandleAndXpath:
70 description: Create a node with descendants for the given CM Handle; top level or under existing node (requires xpath)
74 summary: Create a node with descendants
75 operationId: createNode
77 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
78 - $ref: 'components.yaml#/components/parameters/xpathInQuery'
87 $ref: 'components.yaml#/components/responses/Created'
89 $ref: 'components.yaml#/components/responses/BadRequest'
91 $ref: 'components.yaml#/components/responses/Unauthorized'
93 $ref: 'components.yaml#/components/responses/Forbidden'
95 $ref: 'components.yaml#/components/responses/NotFound'
98 description: Update node leaves for the given cps path and cm Handle
102 summary: Update node leaves
103 operationId: updateNodeLeaves
105 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
106 - $ref: 'components.yaml#/components/parameters/xpathInQuery'
115 $ref: 'components.yaml#/components/responses/Ok'
117 $ref: 'components.yaml#/components/responses/BadRequest'
119 $ref: 'components.yaml#/components/responses/Unauthorized'
121 $ref: 'components.yaml#/components/responses/Forbidden'
123 $ref: 'components.yaml#/components/responses/NotFound'
126 description: Replace a node with descendants for the given cps path and cm Handle
130 summary: Replace a node with descendants
131 operationId: replaceNode
133 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
134 - $ref: 'components.yaml#/components/parameters/xpathInQuery'
143 $ref: 'components.yaml#/components/responses/Ok'
145 $ref: 'components.yaml#/components/responses/BadRequest'
147 $ref: 'components.yaml#/components/responses/Unauthorized'
149 $ref: 'components.yaml#/components/responses/Forbidden'
151 $ref: 'components.yaml#/components/responses/NotFound'
153 listNodeByCmHandleAndXpath:
155 description: Add one or more list-node child elements under existing node for the given CM Handle
159 summary: Add list-node child element(s)
160 operationId: addListNodeElements
162 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
163 - $ref: 'components.yaml#/components/parameters/requiredXpathInQuery'
172 $ref: 'components.yaml#/components/responses/Created'
174 $ref: 'components.yaml#/components/responses/BadRequest'
176 $ref: 'components.yaml#/components/responses/Unauthorized'
178 $ref: 'components.yaml#/components/responses/Forbidden'
180 $ref: 'components.yaml#/components/responses/NotFound'
182 updateDmiRegistration:
184 description: Register a DMI Plugin with any new CM Handles.
187 summary: DMI notifies NCMP of new CM Handles
188 operationId: updateDmiPluginRegistration
194 $ref: 'components.yaml#/components/schemas/RestDmiPluginRegistration'
197 $ref: 'components.yaml#/components/responses/Created'
199 $ref: 'components.yaml#/components/responses/BadRequest'
201 $ref: 'components.yaml#/components/responses/Unauthorized'
203 $ref: 'components.yaml#/components/responses/Forbidden'
205 getResourceDataForPassthroughOperational:
209 summary: Get resource data from pass-through operational for cm handle
210 description: Get resource data from pass-through operational for given cm handle
211 operationId: getResourceDataOperationalForCmHandle
213 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
214 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInPath'
215 - $ref: 'components.yaml#/components/parameters/acceptParamInHeader'
216 - $ref: 'components.yaml#/components/parameters/fieldsParamInQuery'
217 - $ref: 'components.yaml#/components/parameters/depthParamInQuery'
220 $ref: 'components.yaml#/components/responses/Ok'
222 $ref: 'components.yaml#/components/responses/BadRequest'
224 $ref: 'components.yaml#/components/responses/Unauthorized'
226 $ref: 'components.yaml#/components/responses/Forbidden'
228 $ref: 'components.yaml#/components/responses/NotFound'
230 resourceDataForPassthroughRunning:
234 summary: Get resource data from pass-through running for cm handle
235 description: Get resource data from pass-through running for given cm handle
236 operationId: getResourceDataRunningForCmHandle
238 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
239 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInPath'
240 - $ref: 'components.yaml#/components/parameters/acceptParamInHeader'
241 - $ref: 'components.yaml#/components/parameters/fieldsParamInQuery'
242 - $ref: 'components.yaml#/components/parameters/depthParamInQuery'
245 $ref: 'components.yaml#/components/responses/Ok'
247 $ref: 'components.yaml#/components/responses/BadRequest'
249 $ref: 'components.yaml#/components/responses/Unauthorized'
251 $ref: 'components.yaml#/components/responses/Forbidden'
253 $ref: 'components.yaml#/components/responses/NotFound'
257 summary: create resource data from pass-through running for cm handle
258 description: create resource data from pass-through running for given cm handle
259 operationId: createResourceDataRunningForCmHandle
261 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
262 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInPath'
263 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
270 application/yang-data+json:
275 $ref: 'components.yaml#/components/responses/Created'
277 $ref: 'components.yaml#/components/responses/BadRequest'
279 $ref: 'components.yaml#/components/responses/Unauthorized'
281 $ref: 'components.yaml#/components/responses/Forbidden'
283 $ref: 'components.yaml#/components/responses/NotFound'