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 nodesByCmHandleAndCpsPath:
44 description: Query nodes for the given cps path and cm Handle
47 summary: Query data nodes
48 operationId: queryNodesByCmHandleAndCpsPath
50 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
51 - $ref: 'components.yaml#/components/parameters/cpsPathInQuery'
52 - $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
55 $ref: 'components.yaml#/components/responses/Ok'
57 $ref: 'components.yaml#/components/responses/BadRequest'
59 $ref: 'components.yaml#/components/responses/Unauthorized'
61 $ref: 'components.yaml#/components/responses/Forbidden'
63 $ref: 'components.yaml#/components/responses/NotFound'
65 nodesByCmHandleAndXpath:
67 description: Create a node with descendants for the given CM Handle; top level or under existing node (requires xpath)
70 summary: Create a node with descendants
71 operationId: createNode
73 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
74 - $ref: 'components.yaml#/components/parameters/xpathInQuery'
83 $ref: 'components.yaml#/components/responses/Created'
85 $ref: 'components.yaml#/components/responses/BadRequest'
87 $ref: 'components.yaml#/components/responses/Unauthorized'
89 $ref: 'components.yaml#/components/responses/Forbidden'
91 $ref: 'components.yaml#/components/responses/NotFound'
94 description: Update node leaves for the given cps path and cm Handle
97 summary: Update node leaves
98 operationId: updateNodeLeaves
100 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
101 - $ref: 'components.yaml#/components/parameters/xpathInQuery'
110 $ref: 'components.yaml#/components/responses/Ok'
112 $ref: 'components.yaml#/components/responses/BadRequest'
114 $ref: 'components.yaml#/components/responses/Unauthorized'
116 $ref: 'components.yaml#/components/responses/Forbidden'
118 $ref: 'components.yaml#/components/responses/NotFound'
121 description: Replace a node with descendants for the given cps path and cm Handle
124 summary: Replace a node with descendants
125 operationId: replaceNode
127 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
128 - $ref: 'components.yaml#/components/parameters/xpathInQuery'
137 $ref: 'components.yaml#/components/responses/Ok'
139 $ref: 'components.yaml#/components/responses/BadRequest'
141 $ref: 'components.yaml#/components/responses/Unauthorized'
143 $ref: 'components.yaml#/components/responses/Forbidden'
145 $ref: 'components.yaml#/components/responses/NotFound'