1 # ============LICENSE_START=======================================================
2 # Copyright (c) 2021-2022 Bell Canada.
3 # Modifications Copyright (C) 2021-2022 Nordix Foundation
4 # Modifications Copyright (C) 2022 TechMahindra Ltd.
5 # ================================================================================
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
18 # SPDX-License-Identifier: Apache-2.0
19 # ============LICENSE_END=========================================================
26 title: Anchor details by anchor Name
36 example: my-schema-set
40 title: Dataspace details by dataspace Name
64 description: multipartFile
66 example: 'https://github.com/onap/cps/blob/master/cps-service/src/test/resources/bookstore.yang'
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 dataspaceNameInQuery:
114 description: dataspace-name
118 example: my-dataspace
122 description: dataspace-name
126 example: my-dataspace
130 description: anchor-name
135 schemaSetNameInQuery:
136 name: schema-set-name
138 description: schema-set-name
142 example: my-schema-set
144 name: schema-set-name
146 description: schema-set-name
150 example: my-schema-set
154 description: anchor-name
162 description: For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html
169 value: /shops/bookstore
170 list attributes xpath:
171 value: /shops/bookstore/categories[@code=1]
172 requiredXpathInQuery:
175 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]
187 description: For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html
195 list attributes cps path:
196 value: //categories[@code=1]
197 includeDescendantsOptionInQuery:
198 name: include-descendants
200 description: include-descendants
206 observedTimestampInQuery:
207 name: observed-timestamp
209 description: observed-timestamp
213 example: '2021-03-21T00:10:34.030-0100'
217 description: apiVersion
226 description: The specified resource was not found
230 $ref: '#/components/schemas/ErrorMessage'
233 message: Resource Not Found
234 details: The requested resource is not found
236 description: Unauthorized
240 $ref: '#/components/schemas/ErrorMessage'
243 message: Unauthorized request
244 details: This request is unauthorized
246 description: Forbidden
250 $ref: '#/components/schemas/ErrorMessage'
253 message: Request Forbidden
254 details: This request is forbidden
256 description: Bad Request
260 $ref: '#/components/schemas/ErrorMessage'
264 details: The provided request is not valid
266 description: Conflict
270 $ref: '#/components/schemas/ErrorMessage'
273 message: Conflicting request
274 details: The request cannot be processed as the resource is in use.
292 description: Created without response body
294 description: Internal Server Error
298 $ref: "#/components/schemas/ErrorMessage"
301 message: Internal Server Error
302 details: Internal Server Error occurred
304 description: No Content