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'
58 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
67 $ref: 'components.yml#/components/responses/Created'
69 $ref: 'components.yml#/components/responses/BadRequest'
71 $ref: 'components.yml#/components/responses/Unauthorized'
73 $ref: 'components.yml#/components/responses/Forbidden'
76 description: Replace list-node child elements under existing node for a given anchor and dataspace
79 summary: Replace list-node child element(s) under existing parent node
80 operationId: replaceListNodeElements
82 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
83 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
84 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
85 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
94 $ref: 'components.yml#/components/responses/Created'
96 $ref: 'components.yml#/components/responses/BadRequest'
98 $ref: 'components.yml#/components/responses/Unauthorized'
100 $ref: 'components.yml#/components/responses/Forbidden'
103 description: Delete list-node child elements under existing node for a given anchor and dataspace
106 summary: Delete list-node child element(s) under existing parent node
107 operationId: deleteListNodeElements
109 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
110 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
111 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
112 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
115 $ref: 'components.yml#/components/responses/NoContent'
117 $ref: 'components.yml#/components/responses/BadRequest'
119 $ref: 'components.yml#/components/responses/Unauthorized'
121 $ref: 'components.yml#/components/responses/Forbidden'
123 nodesByDataspaceAndAnchor:
125 description: Create a node for a given anchor and dataspace
128 summary: Create a node
129 operationId: createNode
131 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
132 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
133 - $ref: 'components.yml#/components/parameters/xpathInQuery'
134 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
143 $ref: 'components.yml#/components/responses/Created'
145 $ref: 'components.yml#/components/responses/BadRequest'
147 $ref: 'components.yml#/components/responses/Unauthorized'
149 $ref: 'components.yml#/components/responses/Forbidden'
152 description: Update a data node leaves for a given dataspace and anchor and a parent node xpath
155 summary: Update node leaves
156 operationId: updateNodeLeaves
158 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
159 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
160 - $ref: 'components.yml#/components/parameters/xpathInQuery'
161 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
170 $ref: 'components.yml#/components/responses/Ok'
172 $ref: 'components.yml#/components/responses/BadRequest'
174 $ref: 'components.yml#/components/responses/Unauthorized'
176 $ref: 'components.yml#/components/responses/Forbidden'
179 description: Replace a node with descendants for a given dataspace, anchor and a parent node xpath
182 summary: Replace a node with descendants
183 operationId: replaceNode
185 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
186 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
187 - $ref: 'components.yml#/components/parameters/xpathInQuery'
188 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
197 $ref: 'components.yml#/components/responses/Ok'
199 $ref: 'components.yml#/components/responses/BadRequest'
201 $ref: 'components.yml#/components/responses/Unauthorized'
203 $ref: 'components.yml#/components/responses/Forbidden'
208 description: Get all nodes for a given dataspace using an xpath or schema node identifier - DRAFT
212 operationId: getNodesByDataspace
214 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
217 $ref: 'components.yml#/components/responses/Ok'
219 $ref: 'components.yml#/components/responses/BadRequest'
221 $ref: 'components.yml#/components/responses/Unauthorized'
223 $ref: 'components.yml#/components/responses/Forbidden'
225 $ref: 'components.yml#/components/responses/NotFound'
226 x-codegen-request-body-name: requestBody