1 # ============LICENSE_START=======================================================
2 # Copyright (c) 2021-2022 Bell Canada.
3 # Modifications Copyright (C) 2021-2022 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
67 example: 'https://github.com/onap/cps/blob/master/cps-service/src/test/resources/bookstore.yang'
71 title: Module reference object
75 example: my-module-reference-name
78 example: my-module-reference-namespace
81 example: my-module-reference-revision
85 title: Schema set details by dataspace and schemasetName
95 $ref: '#/components/schemas/ModuleReferences'
98 example: my-schema-set
104 bookstore-name: Chapters
112 <stores xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
113 <bookstore xmlns="org:onap:ccsdk:sample">
114 <bookstore-name>Chapters</bookstore-name>
121 dataSampleAcrossAnchors:
123 - anchorName: bookstore1
126 bookstore-name: Chapters
132 - anchorName: bookstore2
135 bookstore-name: Chapters
143 dataspaceNameInQuery:
146 description: dataspace-name
150 example: my-dataspace
154 description: dataspace-name
158 example: my-dataspace
162 description: anchor-name
167 schemaSetNameInQuery:
168 name: schema-set-name
170 description: schema-set-name
174 example: my-schema-set
176 name: schema-set-name
178 description: schema-set-name
182 example: my-schema-set
186 description: anchor-name
194 description: For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html
201 value: /shops/bookstore
202 list attributes xpath:
203 value: /shops/bookstore/categories[@code=1]
204 requiredXpathInQuery:
207 description: For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html
213 value: /shops/bookstore
214 list attributes xpath:
215 value: /shops/bookstore/categories[@code=1]
219 description: For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html
227 list attributes cps path:
228 value: //categories[@code=1]
229 includeDescendantsOptionInQuery:
230 name: include-descendants
232 description: include-descendants
238 observedTimestampInQuery:
239 name: observed-timestamp
241 description: observed-timestamp
245 example: '2021-03-21T00:10:34.030-0100'
249 description: apiVersion
258 description: Content type header
261 example: 'application/json'
266 description: Number of descendants to query. Allowed values are 'none', 'all', -1 (for all), 0 (for none) and any positive number.
275 description: The specified resource was not found
279 $ref: '#/components/schemas/ErrorMessage'
282 message: Resource Not Found
283 details: The requested resource is not found
285 description: Unauthorized
289 $ref: '#/components/schemas/ErrorMessage'
292 message: Unauthorized request
293 details: This request is unauthorized
295 description: Forbidden
299 $ref: '#/components/schemas/ErrorMessage'
302 message: Request Forbidden
303 details: This request is forbidden
305 description: Bad Request
309 $ref: '#/components/schemas/ErrorMessage'
313 details: The provided request is not valid
315 description: Conflict
319 $ref: '#/components/schemas/ErrorMessage'
322 message: Conflicting request
323 details: The request cannot be processed as the resource is in use.
341 description: Created without response body
343 description: Internal Server Error
347 $ref: "#/components/schemas/ErrorMessage"
350 message: Internal Server Error
351 details: Internal Server Error occurred
353 description: No Content