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.
16 # SPDX-License-Identifier: Apache-2.0
17 # ============LICENSE_END=========================================================
24 title: Anchor details by anchor Name
34 example: my-schema-set
54 description: multipartFile
56 example: 'https://github.com/onap/cps/blob/master/cps-service/src/test/resources/bookstore.yang'
60 title: Module reference object
64 example: my-module-reference-name
67 example: my-module-reference-namespace
70 example: my-module-reference-revision
74 title: Schema set details by dataspace and schemasetName
82 $ref: '#/components/schemas/ModuleReferences'
85 example: my-schema-set
91 bookstore-name: Chapters
99 summary: The data node returned does not include the root node. This is being investigated as a part of CPS-461
101 bookstore-name: Chapters
109 dataspaceNameInQuery:
112 description: dataspace-name
116 example: my-dataspace
120 description: dataspace-name
124 example: my-dataspace
128 description: anchor-name
133 schemaSetNameInQuery:
134 name: schema-set-name
136 description: schema-set-name
140 example: my-schema-set
142 name: schema-set-name
144 description: schema-set-name
148 example: my-schema-set
152 description: anchor-name
160 description: For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html
167 value: /shops/bookstore
168 list attributes xpath:
169 value: /shops/bookstore/categories[@code=1]
170 requiredXpathInQuery:
173 description: For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html
179 value: /shops/bookstore
180 list attributes xpath:
181 value: /shops/bookstore/categories[@code=1]
185 description: For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html
193 list attributes cps path:
194 value: //categories[@code=1]
195 includeDescendantsOptionInQuery:
196 name: include-descendants
198 description: include-descendants
204 observedTimestampInQuery:
205 name: observed-timestamp
207 description: observed-timestamp
211 example: '2021-03-21T00:10:34.030-0100'
215 description: The specified resource was not found
219 $ref: '#/components/schemas/ErrorMessage'
222 message: Resource Not Found
223 details: The requested resource is not found
225 description: Unauthorized
229 $ref: '#/components/schemas/ErrorMessage'
232 message: Unauthorized request
233 details: This request is unauthorized
235 description: Forbidden
239 $ref: '#/components/schemas/ErrorMessage'
242 message: Request Forbidden
243 details: This request is forbidden
245 description: Bad Request
249 $ref: '#/components/schemas/ErrorMessage'
253 details: The provided request is not valid
255 description: Conflict
259 $ref: '#/components/schemas/ErrorMessage'
262 message: Conflicting request
263 details: The request cannot be processed as the resource is in use.
281 description: No Content