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.
16 # SPDX-License-Identifier: Apache-2.0
17 # ============LICENSE_END=========================================================
19 nodeByDataspaceAndAnchor:
21 description: Get a node with an option to retrieve all the children for a given anchor and dataspace
25 operationId: getNodeByDataspaceAndAnchor
27 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
28 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
29 - $ref: 'components.yml#/components/parameters/xpathInQuery'
30 - $ref: 'components.yml#/components/parameters/includeDescendantsOptionInQuery'
40 $ref: 'components.yml#/components/examples/dataSampleResponse'
42 $ref: 'components.yml#/components/responses/BadRequest'
44 $ref: 'components.yml#/components/responses/Unauthorized'
46 $ref: 'components.yml#/components/responses/Forbidden'
48 $ref: 'components.yml#/components/responses/NotFound'
49 x-codegen-request-body-name: xpath
51 listElementByDataspaceAndAnchor:
53 description: Add list element(s) to a list for a given anchor and dataspace
56 summary: Add list element(s)
57 operationId: addListElements
59 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
60 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
61 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
62 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
71 $ref: 'components.yml#/components/examples/dataSampleRequest'
74 $ref: 'components.yml#/components/responses/Created'
76 $ref: 'components.yml#/components/responses/BadRequest'
78 $ref: 'components.yml#/components/responses/Unauthorized'
80 $ref: 'components.yml#/components/responses/Forbidden'
83 description: Replace list content under a given parent, anchor and dataspace
86 summary: Replace list content
87 operationId: replaceListContent
89 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
90 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
91 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
92 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
101 $ref: 'components.yml#/components/examples/dataSampleRequest'
104 $ref: 'components.yml#/components/responses/Ok'
106 $ref: 'components.yml#/components/responses/BadRequest'
108 $ref: 'components.yml#/components/responses/Unauthorized'
110 $ref: 'components.yml#/components/responses/Forbidden'
113 description: Delete one or all list element(s) for a given anchor and dataspace
117 summary: Delete one or all list element(s)
118 operationId: deleteListOrListElement
120 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
121 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
122 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
123 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
126 $ref: 'components.yml#/components/responses/NoContent'
128 $ref: 'components.yml#/components/responses/BadRequest'
130 $ref: 'components.yml#/components/responses/Unauthorized'
132 $ref: 'components.yml#/components/responses/Forbidden'
134 nodesByDataspaceAndAnchor:
136 description: Create a node for a given anchor and dataspace
139 summary: Create a node
140 operationId: createNode
142 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
143 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
144 - $ref: 'components.yml#/components/parameters/xpathInQuery'
145 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
154 $ref: 'components.yml#/components/examples/dataSampleRequest'
157 $ref: 'components.yml#/components/responses/Created'
159 $ref: 'components.yml#/components/responses/BadRequest'
161 $ref: 'components.yml#/components/responses/Unauthorized'
163 $ref: 'components.yml#/components/responses/Forbidden'
166 description: Update a data node leaves for a given dataspace and anchor and a parent node xpath
169 summary: Update node leaves
170 operationId: updateNodeLeaves
172 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
173 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
174 - $ref: 'components.yml#/components/parameters/xpathInQuery'
175 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
184 $ref: 'components.yml#/components/examples/dataSampleRequest'
187 $ref: 'components.yml#/components/responses/Ok'
189 $ref: 'components.yml#/components/responses/BadRequest'
191 $ref: 'components.yml#/components/responses/Unauthorized'
193 $ref: 'components.yml#/components/responses/Forbidden'
196 description: Delete a datanode for a given dataspace and anchor given a node xpath.
199 summary: Delete a data node
200 operationId: deleteDataNode
202 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
203 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
204 - $ref: 'components.yml#/components/parameters/xpathInQuery'
205 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
208 $ref: 'components.yml#/components/responses/NoContent'
210 $ref: 'components.yml#/components/responses/BadRequest'
212 $ref: 'components.yml#/components/responses/Unauthorized'
214 $ref: 'components.yml#/components/responses/Forbidden'
218 description: Replace a node with descendants for a given dataspace, anchor and a parent node xpath
221 summary: Replace a node with descendants
222 operationId: replaceNode
224 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
225 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
226 - $ref: 'components.yml#/components/parameters/xpathInQuery'
227 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
236 $ref: 'components.yml#/components/examples/dataSampleRequest'
239 $ref: 'components.yml#/components/responses/Ok'
241 $ref: 'components.yml#/components/responses/BadRequest'
243 $ref: 'components.yml#/components/responses/Unauthorized'
245 $ref: 'components.yml#/components/responses/Forbidden'