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'
38 example: { "child": my_child,"leafList": "leafListElement1, leafListElement2", "leaf": my_leaf }
40 $ref: 'components.yml#/components/responses/BadRequest'
42 $ref: 'components.yml#/components/responses/Unauthorized'
44 $ref: 'components.yml#/components/responses/Forbidden'
46 $ref: 'components.yml#/components/responses/NotFound'
47 x-codegen-request-body-name: xpath
49 listNodeByDataspaceAndAnchor:
51 description: Add list-node child elements to existing node for a given anchor and dataspace
54 summary: Add list-node child element(s) under existing parent node
55 operationId: addListNodeElements
57 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
58 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
59 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
60 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
69 $ref: 'components.yml#/components/responses/Created'
71 $ref: 'components.yml#/components/responses/BadRequest'
73 $ref: 'components.yml#/components/responses/Unauthorized'
75 $ref: 'components.yml#/components/responses/Forbidden'
78 description: Replace list-node child elements under existing node for a given anchor and dataspace
81 summary: Replace list-node child element(s) under existing parent node
82 operationId: replaceListNodeElements
84 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
85 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
86 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
87 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
96 $ref: 'components.yml#/components/responses/Created'
98 $ref: 'components.yml#/components/responses/BadRequest'
100 $ref: 'components.yml#/components/responses/Unauthorized'
102 $ref: 'components.yml#/components/responses/Forbidden'
105 description: Delete list-node child elements under existing node for a given anchor and dataspace
108 summary: Delete list-node child element(s) under existing parent node
109 operationId: deleteListNodeElements
111 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
112 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
113 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
114 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
117 $ref: 'components.yml#/components/responses/NoContent'
119 $ref: 'components.yml#/components/responses/BadRequest'
121 $ref: 'components.yml#/components/responses/Unauthorized'
123 $ref: 'components.yml#/components/responses/Forbidden'
125 nodesByDataspaceAndAnchor:
127 description: Create a node for a given anchor and dataspace
130 summary: Create a node
131 operationId: createNode
133 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
134 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
135 - $ref: 'components.yml#/components/parameters/xpathInQuery'
136 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
145 $ref: 'components.yml#/components/responses/Created'
147 $ref: 'components.yml#/components/responses/BadRequest'
149 $ref: 'components.yml#/components/responses/Unauthorized'
151 $ref: 'components.yml#/components/responses/Forbidden'
154 description: Update a data node leaves for a given dataspace and anchor and a parent node xpath
157 summary: Update node leaves
158 operationId: updateNodeLeaves
160 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
161 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
162 - $ref: 'components.yml#/components/parameters/xpathInQuery'
163 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
172 $ref: 'components.yml#/components/responses/Ok'
174 $ref: 'components.yml#/components/responses/BadRequest'
176 $ref: 'components.yml#/components/responses/Unauthorized'
178 $ref: 'components.yml#/components/responses/Forbidden'
181 description: Replace a node with descendants for a given dataspace, anchor and a parent node xpath
184 summary: Replace a node with descendants
185 operationId: replaceNode
187 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
188 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
189 - $ref: 'components.yml#/components/parameters/xpathInQuery'
190 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
199 $ref: 'components.yml#/components/responses/Ok'
201 $ref: 'components.yml#/components/responses/BadRequest'
203 $ref: 'components.yml#/components/responses/Unauthorized'
205 $ref: 'components.yml#/components/responses/Forbidden'