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.
15 # ============LICENSE_END=========================================================
17 nodeByDataspaceAndAnchor:
19 description: Get a node with an option to retrieve all the children for a given anchor and dataspace
23 operationId: getNodeByDataspaceAndAnchor
25 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
26 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
27 - $ref: 'components.yml#/components/parameters/xpathInQuery'
28 - $ref: 'components.yml#/components/parameters/includeDescendantsOptionInQuery'
31 $ref: 'components.yml#/components/responses/Ok'
33 $ref: 'components.yml#/components/responses/BadRequest'
35 $ref: 'components.yml#/components/responses/Unauthorized'
37 $ref: 'components.yml#/components/responses/Forbidden'
39 $ref: 'components.yml#/components/responses/NotFound'
40 x-codegen-request-body-name: xpath
42 listNodeByDataspaceAndAnchor:
44 description: Add list-node child elements to existing node for a given anchor and dataspace
47 summary: Add list-node child element(s) under existing parent node
48 operationId: addListNodeElements
50 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
51 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
52 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
61 $ref: 'components.yml#/components/responses/Created'
63 $ref: 'components.yml#/components/responses/BadRequest'
65 $ref: 'components.yml#/components/responses/Unauthorized'
67 $ref: 'components.yml#/components/responses/Forbidden'
70 description: Replace list-node child elements under existing node for a given anchor and dataspace
73 summary: Replace list-node child element(s) under existing parent node
74 operationId: replaceListNodeElements
76 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
77 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
78 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
87 $ref: 'components.yml#/components/responses/Created'
89 $ref: 'components.yml#/components/responses/BadRequest'
91 $ref: 'components.yml#/components/responses/Unauthorized'
93 $ref: 'components.yml#/components/responses/Forbidden'
95 nodesByDataspaceAndAnchor:
97 description: Create a node for a given anchor and dataspace
100 summary: Create a node
101 operationId: createNode
103 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
104 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
105 - $ref: 'components.yml#/components/parameters/xpathInQuery'
114 $ref: 'components.yml#/components/responses/Created'
116 $ref: 'components.yml#/components/responses/BadRequest'
118 $ref: 'components.yml#/components/responses/Unauthorized'
120 $ref: 'components.yml#/components/responses/Forbidden'
123 description: Update a data node leaves for a given dataspace and anchor and a parent node xpath
126 summary: Update node leaves
127 operationId: updateNodeLeaves
129 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
130 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
131 - $ref: 'components.yml#/components/parameters/xpathInQuery'
140 $ref: 'components.yml#/components/responses/Ok'
142 $ref: 'components.yml#/components/responses/BadRequest'
144 $ref: 'components.yml#/components/responses/Unauthorized'
146 $ref: 'components.yml#/components/responses/Forbidden'
149 description: Replace a node with descendants for a given dataspace, anchor and a parent node xpath
152 summary: Replace a node with descendants
153 operationId: replaceNode
155 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
156 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
157 - $ref: 'components.yml#/components/parameters/xpathInQuery'
166 $ref: 'components.yml#/components/responses/Ok'
168 $ref: 'components.yml#/components/responses/BadRequest'
170 $ref: 'components.yml#/components/responses/Unauthorized'
172 $ref: 'components.yml#/components/responses/Forbidden'
177 description: Get all nodes for a given dataspace using an xpath or schema node identifier - DRAFT
181 operationId: getNodesByDataspace
183 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
186 $ref: 'components.yml#/components/responses/Ok'
188 $ref: 'components.yml#/components/responses/BadRequest'
190 $ref: 'components.yml#/components/responses/Unauthorized'
192 $ref: 'components.yml#/components/responses/Forbidden'
194 $ref: 'components.yml#/components/responses/NotFound'
195 x-codegen-request-body-name: requestBody