1 # ============LICENSE_START=======================================================
2 # Copyright (c) 2021 Bell Canada.
3 # ================================================================================
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
8 # 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.
15 # ============LICENSE_END=========================================================
17 nodeByDataspaceAndAnchor:
19 description: Get a node with an option to retrieve all the children for a given anchor and dataspace
23 operationId: getNodeByDataspaceAndAnchor
25 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
26 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
27 - $ref: 'components.yml#/components/parameters/xpathInQuery'
28 - $ref: 'components.yml#/components/parameters/includeDescendantsOptionInQuery'
36 example: { "child": my_child,"leafList": "leafListElement1, leafListElement2", "leaf": my_leaf }
38 $ref: 'components.yml#/components/responses/BadRequest'
40 $ref: 'components.yml#/components/responses/Unauthorized'
42 $ref: 'components.yml#/components/responses/Forbidden'
44 $ref: 'components.yml#/components/responses/NotFound'
45 x-codegen-request-body-name: xpath
47 listNodeByDataspaceAndAnchor:
49 description: Add list-node child elements to existing node for a given anchor and dataspace
52 summary: Add list-node child element(s) under existing parent node
53 operationId: addListNodeElements
55 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
56 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
57 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
66 $ref: 'components.yml#/components/responses/Created'
68 $ref: 'components.yml#/components/responses/BadRequest'
70 $ref: 'components.yml#/components/responses/Unauthorized'
72 $ref: 'components.yml#/components/responses/Forbidden'
75 description: Replace list-node child elements under existing node for a given anchor and dataspace
78 summary: Replace list-node child element(s) under existing parent node
79 operationId: replaceListNodeElements
81 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
82 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
83 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
92 $ref: 'components.yml#/components/responses/Created'
94 $ref: 'components.yml#/components/responses/BadRequest'
96 $ref: 'components.yml#/components/responses/Unauthorized'
98 $ref: 'components.yml#/components/responses/Forbidden'
100 nodesByDataspaceAndAnchor:
102 description: Create a node for a given anchor and dataspace
105 summary: Create a node
106 operationId: createNode
108 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
109 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
110 - $ref: 'components.yml#/components/parameters/xpathInQuery'
119 $ref: 'components.yml#/components/responses/Created'
121 $ref: 'components.yml#/components/responses/BadRequest'
123 $ref: 'components.yml#/components/responses/Unauthorized'
125 $ref: 'components.yml#/components/responses/Forbidden'
128 description: Update a data node leaves for a given dataspace and anchor and a parent node xpath
131 summary: Update node leaves
132 operationId: updateNodeLeaves
134 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
135 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
136 - $ref: 'components.yml#/components/parameters/xpathInQuery'
145 $ref: 'components.yml#/components/responses/Ok'
147 $ref: 'components.yml#/components/responses/BadRequest'
149 $ref: 'components.yml#/components/responses/Unauthorized'
151 $ref: 'components.yml#/components/responses/Forbidden'
154 description: Replace a node with descendants for a given dataspace, anchor and a parent node xpath
157 summary: Replace a node with descendants
158 operationId: replaceNode
160 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
161 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
162 - $ref: 'components.yml#/components/parameters/xpathInQuery'
171 $ref: 'components.yml#/components/responses/Ok'
173 $ref: 'components.yml#/components/responses/BadRequest'
175 $ref: 'components.yml#/components/responses/Unauthorized'
177 $ref: 'components.yml#/components/responses/Forbidden'
182 description: Get all nodes for a given dataspace using an xpath or schema node identifier - DRAFT
186 operationId: getNodesByDataspace
188 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
191 $ref: 'components.yml#/components/responses/Ok'
193 $ref: 'components.yml#/components/responses/BadRequest'
195 $ref: 'components.yml#/components/responses/Unauthorized'
197 $ref: 'components.yml#/components/responses/Forbidden'
199 $ref: 'components.yml#/components/responses/NotFound'
200 x-codegen-request-body-name: requestBody