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 # Modifications Copyright (C) 2022 Deutsche Telekom AG
6 # ================================================================================
7 # Licensed under the Apache License, Version 2.0 (the "License");
8 # you may not use this file except in compliance with the License.
9 # You may obtain a copy of the License at
11 # http://www.apache.org/licenses/LICENSE-2.0
13 # Unless required by applicable law or agreed to in writing, software
14 # distributed under the License is distributed on an "AS IS" BASIS,
15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 # See the License for the specific language governing permissions and
17 # limitations under the License.
19 # SPDX-License-Identifier: Apache-2.0
20 # ============LICENSE_END=========================================================
22 nodeByDataspaceAndAnchor:
24 description: Get a node with an option to retrieve all the children for a given anchor and dataspace
28 operationId: getNodeByDataspaceAndAnchor
30 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
31 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
32 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
33 - $ref: 'components.yml#/components/parameters/xpathInQuery'
34 - $ref: 'components.yml#/components/parameters/includeDescendantsOptionInQuery'
44 $ref: 'components.yml#/components/examples/dataSample'
46 $ref: 'components.yml#/components/responses/BadRequest'
48 $ref: 'components.yml#/components/responses/Unauthorized'
50 $ref: 'components.yml#/components/responses/Forbidden'
52 $ref: 'components.yml#/components/responses/InternalServerError'
53 x-codegen-request-body-name: xpath
55 listElementByDataspaceAndAnchor:
57 description: Add list element(s) to a list for a given anchor and dataspace
60 summary: Add list element(s)
61 operationId: addListElements
63 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
64 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
65 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
66 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
67 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
76 $ref: 'components.yml#/components/examples/dataSample'
79 $ref: 'components.yml#/components/responses/Created'
81 $ref: 'components.yml#/components/responses/BadRequest'
83 $ref: 'components.yml#/components/responses/Unauthorized'
85 $ref: 'components.yml#/components/responses/Forbidden'
87 $ref: 'components.yml#/components/responses/InternalServerError'
89 description: Replace list content under a given parent, anchor and dataspace
92 summary: Replace list content
93 operationId: replaceListContent
95 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
96 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
97 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
98 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
99 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
108 $ref: 'components.yml#/components/examples/dataSample'
111 $ref: 'components.yml#/components/responses/Ok'
113 $ref: 'components.yml#/components/responses/BadRequest'
115 $ref: 'components.yml#/components/responses/Unauthorized'
117 $ref: 'components.yml#/components/responses/Forbidden'
119 $ref: 'components.yml#/components/responses/InternalServerError'
121 nodesByDataspaceAndAnchor:
123 description: Create a node for a given anchor and dataspace
126 summary: Create a node
127 operationId: createNode
129 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
130 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
131 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
132 - $ref: 'components.yml#/components/parameters/xpathInQuery'
133 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
134 - $ref: 'components.yml#/components/parameters/contentTypeHeader'
143 $ref: 'components.yml#/components/examples/dataSample'
146 type: object # Workaround to show example
151 $ref: 'components.yml#/components/examples/dataSampleXml'
155 $ref: 'components.yml#/components/responses/Created'
157 $ref: 'components.yml#/components/responses/BadRequest'
159 $ref: 'components.yml#/components/responses/Unauthorized'
161 $ref: 'components.yml#/components/responses/Forbidden'
163 $ref: 'components.yml#/components/responses/Conflict'
165 $ref: 'components.yml#/components/responses/InternalServerError'
167 description: Update a data node leaves for a given dataspace and anchor and a parent node xpath
170 summary: Update node leaves
171 operationId: updateNodeLeaves
173 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
174 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
175 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
176 - $ref: 'components.yml#/components/parameters/xpathInQuery'
177 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
186 $ref: 'components.yml#/components/examples/dataSample'
189 $ref: 'components.yml#/components/responses/Ok'
191 $ref: 'components.yml#/components/responses/BadRequest'
193 $ref: 'components.yml#/components/responses/Unauthorized'
195 $ref: 'components.yml#/components/responses/Forbidden'
197 $ref: 'components.yml#/components/responses/InternalServerError'
199 description: Delete a datanode for a given dataspace and anchor given a node xpath.
202 summary: Delete a data node
203 operationId: deleteDataNode
205 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
206 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
207 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
208 - $ref: 'components.yml#/components/parameters/xpathInQuery'
209 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
212 $ref: 'components.yml#/components/responses/NoContent'
214 $ref: 'components.yml#/components/responses/BadRequest'
216 $ref: 'components.yml#/components/responses/Unauthorized'
218 $ref: 'components.yml#/components/responses/Forbidden'
220 $ref: 'components.yml#/components/responses/InternalServerError'
222 description: Replace a node with descendants for a given dataspace, anchor and a parent node xpath
225 summary: Replace a node with descendants
226 operationId: replaceNode
228 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
229 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
230 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
231 - $ref: 'components.yml#/components/parameters/xpathInQuery'
232 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
241 $ref: 'components.yml#/components/examples/dataSample'
244 $ref: 'components.yml#/components/responses/Ok'
246 $ref: 'components.yml#/components/responses/BadRequest'
248 $ref: 'components.yml#/components/responses/Unauthorized'
250 $ref: 'components.yml#/components/responses/Forbidden'
252 $ref: 'components.yml#/components/responses/InternalServerError'