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>
123 dataspaceNameInQuery:
126 description: dataspace-name
130 example: my-dataspace
134 description: dataspace-name
138 example: my-dataspace
142 description: anchor-name
147 schemaSetNameInQuery:
148 name: schema-set-name
150 description: schema-set-name
154 example: my-schema-set
156 name: schema-set-name
158 description: schema-set-name
162 example: my-schema-set
166 description: anchor-name
174 description: For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html
181 value: /shops/bookstore
182 list attributes xpath:
183 value: /shops/bookstore/categories[@code=1]
184 requiredXpathInQuery:
187 description: For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html
193 value: /shops/bookstore
194 list attributes xpath:
195 value: /shops/bookstore/categories[@code=1]
199 description: For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html
207 list attributes cps path:
208 value: //categories[@code=1]
209 includeDescendantsOptionInQuery:
210 name: include-descendants
212 description: include-descendants
218 observedTimestampInQuery:
219 name: observed-timestamp
221 description: observed-timestamp
225 example: '2021-03-21T00:10:34.030-0100'
229 description: apiVersion
238 description: Content type header
241 example: 'application/json'
246 description: descendents to query depth of children. allowed values are none, all, any number starting from -1
255 description: The specified resource was not found
259 $ref: '#/components/schemas/ErrorMessage'
262 message: Resource Not Found
263 details: The requested resource is not found
265 description: Unauthorized
269 $ref: '#/components/schemas/ErrorMessage'
272 message: Unauthorized request
273 details: This request is unauthorized
275 description: Forbidden
279 $ref: '#/components/schemas/ErrorMessage'
282 message: Request Forbidden
283 details: This request is forbidden
285 description: Bad Request
289 $ref: '#/components/schemas/ErrorMessage'
293 details: The provided request is not valid
295 description: Conflict
299 $ref: '#/components/schemas/ErrorMessage'
302 message: Conflicting request
303 details: The request cannot be processed as the resource is in use.
321 description: Created without response body
323 description: Internal Server Error
327 $ref: "#/components/schemas/ErrorMessage"
330 message: Internal Server Error
331 details: Internal Server Error occurred
333 description: No Content