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/responses/Created'
90 $ref: 'components.yaml#/components/responses/BadRequest'
92 $ref: 'components.yaml#/components/responses/Unauthorized'
94 $ref: 'components.yaml#/components/responses/Forbidden'
96 $ref: 'components.yaml#/components/responses/NotFound'
99 description: Update node leaves for the given cps path and cm Handle
103 summary: Update node leaves
104 operationId: updateNodeLeaves
106 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
107 - $ref: 'components.yaml#/components/parameters/xpathInQuery'
116 $ref: 'components.yaml#/components/responses/Ok'
118 $ref: 'components.yaml#/components/responses/BadRequest'
120 $ref: 'components.yaml#/components/responses/Unauthorized'
122 $ref: 'components.yaml#/components/responses/Forbidden'
124 $ref: 'components.yaml#/components/responses/NotFound'
127 description: Replace a node with descendants for the given cps path and cm Handle
131 summary: Replace a node with descendants
132 operationId: replaceNode
134 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
135 - $ref: 'components.yaml#/components/parameters/xpathInQuery'
144 $ref: 'components.yaml#/components/responses/Ok'
146 $ref: 'components.yaml#/components/responses/BadRequest'
148 $ref: 'components.yaml#/components/responses/Unauthorized'
150 $ref: 'components.yaml#/components/responses/Forbidden'
152 $ref: 'components.yaml#/components/responses/NotFound'
154 listNodeByCmHandleAndXpath:
156 description: Add one or more list-node child elements under existing node for the given CM Handle
160 summary: Add list-node child element(s)
161 operationId: addListNodeElements
163 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
164 - $ref: 'components.yaml#/components/parameters/requiredXpathInQuery'
173 $ref: 'components.yaml#/components/responses/Created'
175 $ref: 'components.yaml#/components/responses/BadRequest'
177 $ref: 'components.yaml#/components/responses/Unauthorized'
179 $ref: 'components.yaml#/components/responses/Forbidden'
181 $ref: 'components.yaml#/components/responses/NotFound'
183 getResourceDataForPassthroughOperational:
187 summary: Get resource data from pass-through operational for cm handle
188 description: Get resource data from pass-through operational for given cm handle
189 operationId: getResourceDataOperationalForCmHandle
191 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
192 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
193 - $ref: 'components.yaml#/components/parameters/acceptParamInHeader'
194 - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
204 $ref: 'components.yaml#/components/examples/dataSampleResponse'
206 $ref: 'components.yaml#/components/responses/BadRequest'
208 $ref: 'components.yaml#/components/responses/Unauthorized'
210 $ref: 'components.yaml#/components/responses/Forbidden'
212 $ref: 'components.yaml#/components/responses/NotFound'
214 resourceDataForPassthroughRunning:
218 summary: Get resource data from pass-through running for cm handle
219 description: Get resource data from pass-through running for given cm handle
220 operationId: getResourceDataRunningForCmHandle
222 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
223 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
224 - $ref: 'components.yaml#/components/parameters/acceptParamInHeader'
225 - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
235 $ref: 'components.yaml#/components/examples/dataSampleResponse'
237 $ref: 'components.yaml#/components/responses/BadRequest'
239 $ref: 'components.yaml#/components/responses/Unauthorized'
241 $ref: 'components.yaml#/components/responses/Forbidden'
243 $ref: 'components.yaml#/components/responses/NotFound'
247 summary: create resource data from pass-through running for cm handle
248 description: create resource data from pass-through running for given cm handle
249 operationId: createResourceDataRunningForCmHandle
251 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
252 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
253 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
262 $ref: 'components.yaml#/components/examples/dataSampleRequest'
263 application/yang-data+json:
268 $ref: 'components.yaml#/components/responses/Created'
270 $ref: 'components.yaml#/components/responses/BadRequest'
272 $ref: 'components.yaml#/components/responses/Unauthorized'
274 $ref: 'components.yaml#/components/responses/Forbidden'
276 $ref: 'components.yaml#/components/responses/NotFound'
281 summary: Update resource data from pass-through running for a cm handle
282 description: Update resource data from pass-through running for the given cm handle
283 operationId: updateResourceDataRunningForCmHandle
285 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
286 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
287 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
296 $ref: 'components.yaml#/components/examples/dataSampleRequest'
297 application/yang-data+json:
302 $ref: 'components.yaml#/components/responses/Ok'
304 $ref: 'components.yaml#/components/responses/BadRequest'
306 $ref: 'components.yaml#/components/responses/Unauthorized'
308 $ref: 'components.yaml#/components/responses/Forbidden'
310 $ref: 'components.yaml#/components/responses/NotFound'
312 fetchModuleReferencesByCmHandle:
314 description: fetch all module references (name and revision) for a given cm handle
317 summary: Fetch all module references (name and revision) for a given cm handle
318 operationId: getModuleReferencesByCmHandle
320 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
329 moduleReferencesResponse:
330 summary: Sample response
332 - moduleName: my-module-name
334 - moduleName: my-module-name-2
337 $ref: 'components.yaml#/components/responses/BadRequest'
339 $ref: 'components.yaml#/components/responses/Unauthorized'
341 $ref: 'components.yaml#/components/responses/Forbidden'
343 $ref: 'components.yaml#/components/responses/NotFound'
345 executeCmHandleSearch:
347 description: Execute cm handle searches using 'hasAllModules' condition to get all cm handles for the given module names
350 summary: Execute cm handle search using the available conditions
351 operationId: executeCmHandleSearch
357 $ref: 'components.yaml#/components/schemas/Conditions'
364 $ref: 'components.yaml#/components/schemas/CmHandles'
366 $ref: 'components.yaml#/components/responses/BadRequest'
368 $ref: 'components.yaml#/components/responses/Unauthorized'
370 $ref: 'components.yaml#/components/responses/Forbidden'