Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / f0f657cab2972f821879c051fabee3e8f590e0b9 / . / cps-rest / docs / openapi / cpsQueryV2.yml
blob: 7f0ceff768f5a95f9399dafed0ea2d41854073b5 [file] [log] [blame]
shivasubedi8df61a92021-06-16 14:43:18 +0100[diff] [blame]1# ============LICENSE_START=======================================================
rajesh.kumarcc21a022022-12-06 11:47:24 +0000[diff] [blame]2# Copyright (C) 2023 TechMahindra Ltd.
shivasubedi8df61a92021-06-16 14:43:18 +0100[diff] [blame]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
7#
8# http://www.apache.org/licenses/LICENSE-2.0
lukegleeson15b93e72021-07-07 15:25:30 +0100[diff] [blame]9#
shivasubedi8df61a92021-06-16 14:43:18 +0100[diff] [blame]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.
15#
16# SPDX-License-Identifier: Apache-2.0
17# ============LICENSE_END=========================================================
18
niamhcore53f07ac2021-02-19 13:14:40 +0000[diff] [blame]19nodesByDataspaceAndAnchorAndCpsPath:
20 get:
21 description: Query data nodes for the given dataspace and anchor using CPS path
22 tags:
23 - cps-query
24 summary: Query data nodes
rajesh.kumarcc21a022022-12-06 11:47:24 +0000[diff] [blame]25 operationId: getNodesByDataspaceAndAnchorAndCpsPathV2
niamhcore53f07ac2021-02-19 13:14:40 +0000[diff] [blame]26 parameters:
27 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
28 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
29 - $ref: 'components.yml#/components/parameters/cpsPathInQuery'
rajesh.kumarcc21a022022-12-06 11:47:24 +0000[diff] [blame]30 - $ref: 'components.yml#/components/parameters/descendantsInQuery'
niamhcore53f07ac2021-02-19 13:14:40 +0000[diff] [blame]31 responses:
32 '200':
puthuparambil.aditya5d8b2412021-11-24 13:35:10 +0000[diff] [blame]33 description: OK
34 content:
35 application/json:
36 schema:
37 type: object
38 examples:
puthuparambil.adityacc17ae52022-02-25 13:24:03 +0000[diff] [blame]39 dataSample:
40 $ref: 'components.yml#/components/examples/dataSample'
niamhcore53f07ac2021-02-19 13:14:40 +0000[diff] [blame]41 '400':
42 $ref: 'components.yml#/components/responses/BadRequest'
niamhcore53f07ac2021-02-19 13:14:40 +0000[diff] [blame]43 '403':
44 $ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]45 '500':
46 $ref: 'components.yml#/components/responses/InternalServerError'
lukegleeson15b93e72021-07-07 15:25:30 +0100[diff] [blame]47 x-codegen-request-body-name: xpath
rajesh.kumara3178902022-12-14 14:27:29 +0000[diff] [blame]48
49nodesByDataspaceAndCpsPath:
50 get:
51 description: Query data nodes for the given dataspace across anchors using CPS path
52 tags:
53 - cps-query
rajesh.kumarf248b5d2023-04-25 11:58:35 +0530[diff] [blame]54 summary: Query data nodes across anchors
rajesh.kumara3178902022-12-14 14:27:29 +0000[diff] [blame]55 operationId: getNodesByDataspaceAndCpsPath
56 parameters:
57 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
58 - $ref: 'components.yml#/components/parameters/cpsPathInQuery'
59 - $ref: 'components.yml#/components/parameters/descendantsInQuery'
rajesh.kumarf248b5d2023-04-25 11:58:35 +0530[diff] [blame]60 - $ref: 'components.yml#/components/parameters/pageIndexInQuery'
61 - $ref: 'components.yml#/components/parameters/pageSizeInQuery'
rajesh.kumara3178902022-12-14 14:27:29 +0000[diff] [blame]62 responses:
63 '200':
64 description: OK
65 content:
66 application/json:
67 schema:
68 type: object
69 examples:
70 dataSample:
71 $ref: 'components.yml#/components/examples/dataSampleAcrossAnchors'
72 '400':
73 $ref: 'components.yml#/components/responses/BadRequest'
rajesh.kumara3178902022-12-14 14:27:29 +0000[diff] [blame]74 '403':
75 $ref: 'components.yml#/components/responses/Forbidden'
76 '500':
77 $ref: 'components.yml#/components/responses/InternalServerError'
78 x-codegen-request-body-name: xpath