1 # ============LICENSE_START=======================================================
2 # Modification (C) 2021 Nordix Foundation
3 # Modification (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
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
16 # SPDX-License-Identifier: Apache-2.0
17 # ============LICENSE_END=========================================================
19 nodeByCmHandleAndXpath:
21 description: Get a node with an option to retrieve all the children for a given cm Handle
24 summary: Get a node given a cm Handle and xpath
25 operationId: getNodeByCmHandleAndXpath
27 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
28 - $ref: 'components.yaml#/components/parameters/xpathInQuery'
29 - $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
32 $ref: 'components.yaml#/components/responses/Ok'
34 $ref: 'components.yaml#/components/responses/BadRequest'
36 $ref: 'components.yaml#/components/responses/Unauthorized'
38 $ref: 'components.yaml#/components/responses/Forbidden'
40 $ref: 'components.yaml#/components/responses/NotFound'
42 $ref: 'components.yaml#/components/responses/NotImplemented'
44 nodesByCmHandleAndCpsPath:
46 description: Query nodes for the given cps path and cm Handle
49 summary: Query data nodes
50 operationId: queryNodesByCmHandleAndCpsPath
52 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
53 - $ref: 'components.yaml#/components/parameters/cpsPathInQuery'
54 - $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
57 $ref: 'components.yaml#/components/responses/Ok'
59 $ref: 'components.yaml#/components/responses/BadRequest'
61 $ref: 'components.yaml#/components/responses/Unauthorized'
63 $ref: 'components.yaml#/components/responses/Forbidden'
65 $ref: 'components.yaml#/components/responses/NotFound'
67 nodesByCmHandleAndXpath:
69 description: Create a node with descendants for the given CM Handle; top level or under existing node (requires xpath)
72 summary: Create a node with descendants
73 operationId: createNode
75 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
76 - $ref: 'components.yaml#/components/parameters/xpathInQuery'
85 $ref: 'components.yaml#/components/responses/Created'
87 $ref: 'components.yaml#/components/responses/BadRequest'
89 $ref: 'components.yaml#/components/responses/Unauthorized'
91 $ref: 'components.yaml#/components/responses/Forbidden'
93 $ref: 'components.yaml#/components/responses/NotFound'
96 description: Update node leaves for the given cps path and cm Handle
99 summary: Update node leaves
100 operationId: updateNodeLeaves
102 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
103 - $ref: 'components.yaml#/components/parameters/xpathInQuery'
112 $ref: 'components.yaml#/components/responses/Ok'
114 $ref: 'components.yaml#/components/responses/BadRequest'
116 $ref: 'components.yaml#/components/responses/Unauthorized'
118 $ref: 'components.yaml#/components/responses/Forbidden'
120 $ref: 'components.yaml#/components/responses/NotFound'
123 description: Replace a node with descendants for the given cps path and cm Handle
126 summary: Replace a node with descendants
127 operationId: replaceNode
129 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
130 - $ref: 'components.yaml#/components/parameters/xpathInQuery'
139 $ref: 'components.yaml#/components/responses/Ok'
141 $ref: 'components.yaml#/components/responses/BadRequest'
143 $ref: 'components.yaml#/components/responses/Unauthorized'
145 $ref: 'components.yaml#/components/responses/Forbidden'
147 $ref: 'components.yaml#/components/responses/NotFound'