1 # ============LICENSE_START=======================================================
2 # Copyright (c) 2021-2022 Bell Canada.
3 # Modifications Copyright (C) 2021-2023 Nordix Foundation
4 # Modifications Copyright (C) 2022-2023 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=========================================================
27 title: Anchor details by anchor Name
37 example: my-schema-set
41 title: Dataspace details by dataspace Name
65 description: multipartFile
70 title: Module reference object
74 example: my-module-reference-name
77 example: my-module-reference-namespace
80 example: my-module-reference-revision
84 title: Schema set details by dataspace and schemasetName
94 $ref: '#/components/schemas/ModuleReferences'
97 example: my-schema-set
103 bookstore-name: Chapters
111 <stores xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
112 <bookstore xmlns="org:onap:ccsdk:sample">
113 <bookstore-name>Chapters</bookstore-name>
120 dataSampleAcrossAnchors:
122 - anchorName: bookstore1
125 bookstore-name: Chapters
131 - anchorName: bookstore2
134 bookstore-name: Chapters
143 xpath: "/bookstore/categories/[@code=3]"
148 xpath: "/bookstore/categories/[@code=1]"
153 xpath: "/bookstore/categories/[@code=2]"
160 dataspaceNameInQuery:
163 description: dataspace-name
167 example: my-dataspace
171 description: dataspace-name
175 example: my-dataspace
179 description: anchor-name
184 schemaSetNameInQuery:
185 name: schema-set-name
187 description: schema-set-name
191 example: my-schema-set
193 name: schema-set-name
195 description: schema-set-name
199 example: my-schema-set
203 description: anchor-name
208 targetAnchorNameInQuery:
209 name: target-anchor-name
211 description: target-anchor-name
219 description: For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html
226 value: /shops/bookstore
227 list attributes xpath:
228 value: /shops/bookstore/categories[@code=1]
229 requiredXpathInQuery:
232 description: For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html
238 value: /shops/bookstore
239 list attributes xpath:
240 value: /shops/bookstore/categories[@code=1]
244 description: For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html
252 list attributes cps path:
253 value: //categories[@code=1]
254 includeDescendantsOptionInQuery:
255 name: include-descendants
257 description: include-descendants
263 observedTimestampInQuery:
264 name: observed-timestamp
266 description: observed-timestamp
270 example: '2021-03-21T00:10:34.030-0100'
274 description: apiVersion
283 description: Content type header
286 example: 'application/json'
291 description: Number of descendants to query. Allowed values are 'none', 'all', 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive number.
300 description: page index for pagination over anchors. It must be greater then zero if provided.
308 description: number of records (anchors) per page. It must be greater then zero if provided.
316 description: The specified resource was not found
320 $ref: '#/components/schemas/ErrorMessage'
323 message: Resource Not Found
324 details: The requested resource is not found
326 description: Unauthorized
330 $ref: '#/components/schemas/ErrorMessage'
333 message: Unauthorized request
334 details: This request is unauthorized
336 description: Forbidden
340 $ref: '#/components/schemas/ErrorMessage'
343 message: Request Forbidden
344 details: This request is forbidden
346 description: Bad Request
350 $ref: '#/components/schemas/ErrorMessage'
354 details: The provided request is not valid
356 description: Conflict
360 $ref: '#/components/schemas/ErrorMessage'
363 message: Conflicting request
364 details: The request cannot be processed as the resource is in use.
382 description: Created without response body
384 description: Internal Server Error
388 $ref: "#/components/schemas/ErrorMessage"
391 message: Internal Server Error
392 details: Internal Server Error occurred
394 description: No Content