1 # ============LICENSE_START=======================================================
2 # Copyright (c) 2021-2022 Bell Canada.
3 # Modifications Copyright (C) 2021-2022 Nordix Foundation
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
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # SPDX-License-Identifier: Apache-2.0
18 # ============LICENSE_END=========================================================
20 nodeByDataspaceAndAnchor:
22 description: Get a node with an option to retrieve all the children for a given anchor and dataspace
26 operationId: getNodeByDataspaceAndAnchor
28 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
29 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
30 - $ref: 'components.yml#/components/parameters/xpathInQuery'
31 - $ref: 'components.yml#/components/parameters/includeDescendantsOptionInQuery'
41 $ref: 'components.yml#/components/examples/dataSample'
43 $ref: 'components.yml#/components/responses/BadRequest'
45 $ref: 'components.yml#/components/responses/Unauthorized'
47 $ref: 'components.yml#/components/responses/Forbidden'
49 $ref: 'components.yml#/components/responses/InternalServerError'
50 x-codegen-request-body-name: xpath
52 listElementByDataspaceAndAnchor:
54 description: Add list element(s) to a list for a given anchor and dataspace
57 summary: Add list element(s)
58 operationId: addListElements
60 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
61 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
62 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
63 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
72 $ref: 'components.yml#/components/examples/dataSample'
75 $ref: 'components.yml#/components/responses/Created'
77 $ref: 'components.yml#/components/responses/BadRequest'
79 $ref: 'components.yml#/components/responses/Unauthorized'
81 $ref: 'components.yml#/components/responses/Forbidden'
83 $ref: 'components.yml#/components/responses/InternalServerError'
85 description: Replace list content under a given parent, anchor and dataspace
88 summary: Replace list content
89 operationId: replaceListContent
91 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
92 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
93 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
94 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
103 $ref: 'components.yml#/components/examples/dataSample'
106 $ref: 'components.yml#/components/responses/Ok'
108 $ref: 'components.yml#/components/responses/BadRequest'
110 $ref: 'components.yml#/components/responses/Unauthorized'
112 $ref: 'components.yml#/components/responses/Forbidden'
114 $ref: 'components.yml#/components/responses/InternalServerError'
116 description: Delete one or all list element(s) for a given anchor and dataspace
120 summary: Delete one or all list element(s)
121 operationId: deleteListOrListElement
123 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
124 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
125 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
126 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
129 $ref: 'components.yml#/components/responses/NoContent'
131 $ref: 'components.yml#/components/responses/BadRequest'
133 $ref: 'components.yml#/components/responses/Unauthorized'
135 $ref: 'components.yml#/components/responses/Forbidden'
137 $ref: 'components.yml#/components/responses/InternalServerError'
139 nodesByDataspaceAndAnchor:
141 description: Create a node for a given anchor and dataspace
144 summary: Create a node
145 operationId: createNode
147 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
148 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
149 - $ref: 'components.yml#/components/parameters/xpathInQuery'
150 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
159 $ref: 'components.yml#/components/examples/dataSample'
162 $ref: 'components.yml#/components/responses/Created'
164 $ref: 'components.yml#/components/responses/BadRequest'
166 $ref: 'components.yml#/components/responses/Unauthorized'
168 $ref: 'components.yml#/components/responses/Forbidden'
170 $ref: 'components.yml#/components/responses/Conflict'
172 $ref: 'components.yml#/components/responses/InternalServerError'
174 description: Update a data node leaves for a given dataspace and anchor and a parent node xpath
177 summary: Update node leaves
178 operationId: updateNodeLeaves
180 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
181 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
182 - $ref: 'components.yml#/components/parameters/xpathInQuery'
183 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
192 $ref: 'components.yml#/components/examples/dataSample'
195 $ref: 'components.yml#/components/responses/Ok'
197 $ref: 'components.yml#/components/responses/BadRequest'
199 $ref: 'components.yml#/components/responses/Unauthorized'
201 $ref: 'components.yml#/components/responses/Forbidden'
203 $ref: 'components.yml#/components/responses/InternalServerError'
205 description: Delete a datanode for a given dataspace and anchor given a node xpath.
208 summary: Delete a data node
209 operationId: deleteDataNode
211 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
212 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
213 - $ref: 'components.yml#/components/parameters/xpathInQuery'
214 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
217 $ref: 'components.yml#/components/responses/NoContent'
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/InternalServerError'
227 description: Replace a node with descendants for a given dataspace, anchor and a parent node xpath
230 summary: Replace a node with descendants
231 operationId: replaceNode
233 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
234 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
235 - $ref: 'components.yml#/components/parameters/xpathInQuery'
236 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
245 $ref: 'components.yml#/components/examples/dataSample'
248 $ref: 'components.yml#/components/responses/Ok'
250 $ref: 'components.yml#/components/responses/BadRequest'
252 $ref: 'components.yml#/components/responses/Unauthorized'
254 $ref: 'components.yml#/components/responses/Forbidden'
256 $ref: 'components.yml#/components/responses/InternalServerError'