1 # ============LICENSE_START=======================================================
2 # Copyright (c) 2021-2022 Bell Canada.
3 # Modifications Copyright (C) 2021-2022 Nordix Foundation
4 # Modifications Copyright (C) 2022 TechMahindra Ltd.
5 # ================================================================================
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
18 # SPDX-License-Identifier: Apache-2.0
19 # ============LICENSE_END=========================================================
21 nodeByDataspaceAndAnchor:
23 description: Get a node with an option to retrieve all the children for a given anchor and dataspace
27 operationId: getNodeByDataspaceAndAnchor
29 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
30 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
31 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
32 - $ref: 'components.yml#/components/parameters/xpathInQuery'
33 - $ref: 'components.yml#/components/parameters/includeDescendantsOptionInQuery'
43 $ref: 'components.yml#/components/examples/dataSample'
45 $ref: 'components.yml#/components/responses/BadRequest'
47 $ref: 'components.yml#/components/responses/Unauthorized'
49 $ref: 'components.yml#/components/responses/Forbidden'
51 $ref: 'components.yml#/components/responses/InternalServerError'
52 x-codegen-request-body-name: xpath
54 listElementByDataspaceAndAnchor:
56 description: Add list element(s) to a list for a given anchor and dataspace
59 summary: Add list element(s)
60 operationId: addListElements
62 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
63 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
64 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
65 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
66 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
75 $ref: 'components.yml#/components/examples/dataSample'
78 $ref: 'components.yml#/components/responses/Created'
80 $ref: 'components.yml#/components/responses/BadRequest'
82 $ref: 'components.yml#/components/responses/Unauthorized'
84 $ref: 'components.yml#/components/responses/Forbidden'
86 $ref: 'components.yml#/components/responses/InternalServerError'
88 description: Replace list content under a given parent, anchor and dataspace
91 summary: Replace list content
92 operationId: replaceListContent
94 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
95 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
96 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
97 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
98 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
107 $ref: 'components.yml#/components/examples/dataSample'
110 $ref: 'components.yml#/components/responses/Ok'
112 $ref: 'components.yml#/components/responses/BadRequest'
114 $ref: 'components.yml#/components/responses/Unauthorized'
116 $ref: 'components.yml#/components/responses/Forbidden'
118 $ref: 'components.yml#/components/responses/InternalServerError'
120 nodesByDataspaceAndAnchor:
122 description: Create a node for a given anchor and dataspace
125 summary: Create a node
126 operationId: createNode
128 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
129 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
130 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
131 - $ref: 'components.yml#/components/parameters/xpathInQuery'
132 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
141 $ref: 'components.yml#/components/examples/dataSample'
144 $ref: 'components.yml#/components/responses/Created'
146 $ref: 'components.yml#/components/responses/BadRequest'
148 $ref: 'components.yml#/components/responses/Unauthorized'
150 $ref: 'components.yml#/components/responses/Forbidden'
152 $ref: 'components.yml#/components/responses/Conflict'
154 $ref: 'components.yml#/components/responses/InternalServerError'
156 description: Update a data node leaves for a given dataspace and anchor and a parent node xpath
159 summary: Update node leaves
160 operationId: updateNodeLeaves
162 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
163 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
164 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
165 - $ref: 'components.yml#/components/parameters/xpathInQuery'
166 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
175 $ref: 'components.yml#/components/examples/dataSample'
178 $ref: 'components.yml#/components/responses/Ok'
180 $ref: 'components.yml#/components/responses/BadRequest'
182 $ref: 'components.yml#/components/responses/Unauthorized'
184 $ref: 'components.yml#/components/responses/Forbidden'
186 $ref: 'components.yml#/components/responses/InternalServerError'
188 description: Delete a datanode for a given dataspace and anchor given a node xpath.
191 summary: Delete a data node
192 operationId: deleteDataNode
194 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
195 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
196 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
197 - $ref: 'components.yml#/components/parameters/xpathInQuery'
198 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
201 $ref: 'components.yml#/components/responses/NoContent'
203 $ref: 'components.yml#/components/responses/BadRequest'
205 $ref: 'components.yml#/components/responses/Unauthorized'
207 $ref: 'components.yml#/components/responses/Forbidden'
209 $ref: 'components.yml#/components/responses/InternalServerError'
211 description: Replace a node with descendants for a given dataspace, anchor and a parent node xpath
214 summary: Replace a node with descendants
215 operationId: replaceNode
217 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
218 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
219 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
220 - $ref: 'components.yml#/components/parameters/xpathInQuery'
221 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
230 $ref: 'components.yml#/components/examples/dataSample'
233 $ref: 'components.yml#/components/responses/Ok'
235 $ref: 'components.yml#/components/responses/BadRequest'
237 $ref: 'components.yml#/components/responses/Unauthorized'
239 $ref: 'components.yml#/components/responses/Forbidden'
241 $ref: 'components.yml#/components/responses/InternalServerError'