1 # ============LICENSE_START=======================================================
2 # Copyright (C) 2021 Nordix Foundation
3 # Modifications Copyright (C) 2021 Pantheon.tech
4 # Modifications Copyright (C) 2021 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=========================================================
21 nodeByCmHandleAndXpath:
23 description: Get a node with an option to retrieve all the children for a given cm Handle
27 summary: Get a node given a cm Handle and xpath
28 operationId: getNodeByCmHandleAndXpath
30 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
31 - $ref: 'components.yaml#/components/parameters/xpathInQuery'
32 - $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
35 $ref: 'components.yaml#/components/responses/Ok'
37 $ref: 'components.yaml#/components/responses/BadRequest'
39 $ref: 'components.yaml#/components/responses/Unauthorized'
41 $ref: 'components.yaml#/components/responses/Forbidden'
43 $ref: 'components.yaml#/components/responses/NotFound'
45 nodesByCmHandleAndCpsPath:
47 description: Query nodes for the given cps path and cm Handle
51 summary: Query data nodes
52 operationId: queryNodesByCmHandleAndCpsPath
54 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
55 - $ref: 'components.yaml#/components/parameters/cpsPathInQuery'
56 - $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
59 $ref: 'components.yaml#/components/responses/Ok'
61 $ref: 'components.yaml#/components/responses/BadRequest'
63 $ref: 'components.yaml#/components/responses/Unauthorized'
65 $ref: 'components.yaml#/components/responses/Forbidden'
67 $ref: 'components.yaml#/components/responses/NotFound'
69 nodesByCmHandleAndXpath:
71 description: Create a node with descendants for the given CM Handle; top level or under existing node (requires xpath)
75 summary: Create a node with descendants
76 operationId: createNode
78 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
79 - $ref: 'components.yaml#/components/parameters/xpathInQuery'
88 $ref: 'components.yaml#/components/examples/dataSampleRequest'
91 $ref: 'components.yaml#/components/responses/Created'
93 $ref: 'components.yaml#/components/responses/BadRequest'
95 $ref: 'components.yaml#/components/responses/Unauthorized'
97 $ref: 'components.yaml#/components/responses/Forbidden'
99 $ref: 'components.yaml#/components/responses/NotFound'
102 description: Update node leaves for the given cps path and cm Handle
106 summary: Update node leaves
107 operationId: updateNodeLeaves
109 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
110 - $ref: 'components.yaml#/components/parameters/xpathInQuery'
119 $ref: 'components.yaml#/components/examples/dataSampleRequest'
122 $ref: 'components.yaml#/components/responses/Ok'
124 $ref: 'components.yaml#/components/responses/BadRequest'
126 $ref: 'components.yaml#/components/responses/Unauthorized'
128 $ref: 'components.yaml#/components/responses/Forbidden'
130 $ref: 'components.yaml#/components/responses/NotFound'
133 description: Replace a node with descendants for the given cps path and cm Handle
137 summary: Replace a node with descendants
138 operationId: replaceNode
140 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
141 - $ref: 'components.yaml#/components/parameters/xpathInQuery'
150 $ref: 'components.yaml#/components/examples/dataSampleRequest'
153 $ref: 'components.yaml#/components/responses/Ok'
155 $ref: 'components.yaml#/components/responses/BadRequest'
157 $ref: 'components.yaml#/components/responses/Unauthorized'
159 $ref: 'components.yaml#/components/responses/Forbidden'
161 $ref: 'components.yaml#/components/responses/NotFound'
163 listNodeByCmHandleAndXpath:
165 description: Add one or more list-node child elements under existing node for the given CM Handle
169 summary: Add list-node child element(s)
170 operationId: addListNodeElements
172 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
173 - $ref: 'components.yaml#/components/parameters/requiredXpathInQuery'
182 $ref: 'components.yaml#/components/examples/dataSampleRequest'
185 $ref: 'components.yaml#/components/responses/Created'
187 $ref: 'components.yaml#/components/responses/BadRequest'
189 $ref: 'components.yaml#/components/responses/Unauthorized'
191 $ref: 'components.yaml#/components/responses/Forbidden'
193 $ref: 'components.yaml#/components/responses/NotFound'
195 getResourceDataForPassthroughOperational:
199 summary: Get resource data from pass-through operational for cm handle
200 description: Get resource data from pass-through operational for given cm handle
201 operationId: getResourceDataOperationalForCmHandle
203 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
204 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
205 - $ref: 'components.yaml#/components/parameters/acceptParamInHeader'
206 - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
216 $ref: 'components.yaml#/components/examples/dataSampleResponse'
218 $ref: 'components.yaml#/components/responses/BadRequest'
220 $ref: 'components.yaml#/components/responses/Unauthorized'
222 $ref: 'components.yaml#/components/responses/Forbidden'
224 $ref: 'components.yaml#/components/responses/NotFound'
226 resourceDataForPassthroughRunning:
230 summary: Get resource data from pass-through running for cm handle
231 description: Get resource data from pass-through running for given cm handle
232 operationId: getResourceDataRunningForCmHandle
234 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
235 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
236 - $ref: 'components.yaml#/components/parameters/acceptParamInHeader'
237 - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
247 $ref: 'components.yaml#/components/examples/dataSampleResponse'
249 $ref: 'components.yaml#/components/responses/BadRequest'
251 $ref: 'components.yaml#/components/responses/Unauthorized'
253 $ref: 'components.yaml#/components/responses/Forbidden'
255 $ref: 'components.yaml#/components/responses/NotFound'
259 summary: create resource data from pass-through running for cm handle
260 description: create resource data from pass-through running for given cm handle
261 operationId: createResourceDataRunningForCmHandle
263 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
264 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
265 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
274 $ref: 'components.yaml#/components/examples/dataSampleRequest'
275 application/yang-data+json:
280 $ref: 'components.yaml#/components/examples/dataSampleRequest'
283 $ref: 'components.yaml#/components/responses/Created'
285 $ref: 'components.yaml#/components/responses/BadRequest'
287 $ref: 'components.yaml#/components/responses/Unauthorized'
289 $ref: 'components.yaml#/components/responses/Forbidden'
291 $ref: 'components.yaml#/components/responses/NotFound'
296 summary: Update resource data from pass-through running for a cm handle
297 description: Update resource data from pass-through running for the given cm handle
298 operationId: updateResourceDataRunningForCmHandle
300 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
301 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
302 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
311 $ref: 'components.yaml#/components/examples/dataSampleRequest'
312 application/yang-data+json:
317 $ref: 'components.yaml#/components/examples/dataSampleRequest'
320 $ref: 'components.yaml#/components/responses/Ok'
322 $ref: 'components.yaml#/components/responses/BadRequest'
324 $ref: 'components.yaml#/components/responses/Unauthorized'
326 $ref: 'components.yaml#/components/responses/Forbidden'
328 $ref: 'components.yaml#/components/responses/NotFound'
333 summary: Patch resource data from pass-through running
334 description: Patch resource data from pass-through running for the given cm handle
335 operationId: patchResourceDataRunningForCmHandle
337 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
338 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
339 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
348 $ref: 'components.yaml#/components/examples/dataSampleRequest'
351 $ref: 'components.yaml#/components/responses/Ok'
353 $ref: 'components.yaml#/components/responses/BadRequest'
355 $ref: 'components.yaml#/components/responses/Unauthorized'
357 $ref: 'components.yaml#/components/responses/Forbidden'
359 $ref: 'components.yaml#/components/responses/NotFound'
364 summary: Delete resource data
365 description: Delete resource data from pass-through running for a given cm handle
366 operationId: deleteResourceDataRunningForCmHandle
368 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
369 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
370 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
379 $ref: 'components.yaml#/components/examples/dataSampleRequest'
382 $ref: 'components.yaml#/components/responses/NoContent'
384 $ref: 'components.yaml#/components/responses/BadRequest'
386 $ref: 'components.yaml#/components/responses/Unauthorized'
388 $ref: 'components.yaml#/components/responses/Forbidden'
390 $ref: 'components.yaml#/components/responses/NotFound'
393 fetchModuleReferencesByCmHandle:
395 description: fetch all module references (name and revision) for a given cm handle
398 summary: Fetch all module references (name and revision) for a given cm handle
399 operationId: getModuleReferencesByCmHandle
401 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
410 $ref: 'components.yaml#/components/schemas/ModuleReference'
412 $ref: 'components.yaml#/components/responses/BadRequest'
414 $ref: 'components.yaml#/components/responses/Unauthorized'
416 $ref: 'components.yaml#/components/responses/Forbidden'
418 $ref: 'components.yaml#/components/responses/NotFound'
420 executeCmHandleSearch:
422 description: Execute cm handle searches using 'hasAllModules' condition to get all cm handles for the given module names
425 summary: Execute cm handle search using the available conditions
426 operationId: executeCmHandleSearch
432 $ref: 'components.yaml#/components/schemas/Conditions'
439 $ref: 'components.yaml#/components/schemas/CmHandles'
441 $ref: 'components.yaml#/components/responses/BadRequest'
443 $ref: 'components.yaml#/components/responses/Unauthorized'
445 $ref: 'components.yaml#/components/responses/Forbidden'