Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / 64ff45847a3466cb24a8dab57b65be753ee3cd03 / . / cps-rest / docs / openapi / cpsDataV2.yml
blob: d5a8ef3891ea92b424ccb525b0d0e29901fb0656 [file] [log] [blame]
rajesh.kumarcc21a022022-12-06 11:47:24 +0000[diff] [blame]1# ============LICENSE_START=======================================================
Arpit Singhd7fa9602023-09-07 17:05:37 +0530[diff] [blame]2# Copyright (c) 2022-2024 TechMahindra Ltd.
rajesh.kumarcc21a022022-12-06 11:47:24 +0000[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
9#
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
19nodeByDataspaceAndAnchor:
20 get:
21 description: Get a node with an option to retrieve all the children for a given anchor and dataspace
22 tags:
23 - cps-data
24 summary: Get a node
25 operationId: getNodeByDataspaceAndAnchorV2
26 parameters:
27 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
28 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
29 - $ref: 'components.yml#/components/parameters/xpathInQuery'
30 - $ref: 'components.yml#/components/parameters/descendantsInQuery'
31 responses:
32 '200':
33 description: OK
34 content:
35 application/json:
36 schema:
37 type: object
38 examples:
39 dataSample:
40 $ref: 'components.yml#/components/examples/dataSample'
41 '400':
42 $ref: 'components.yml#/components/responses/BadRequest'
rajesh.kumarcc21a022022-12-06 11:47:24 +0000[diff] [blame]43 '403':
44 $ref: 'components.yml#/components/responses/Forbidden'
45 '500':
46 $ref: 'components.yml#/components/responses/InternalServerError'
Arpit Singh0339c712023-08-02 18:35:31 +0530[diff] [blame]47 x-codegen-request-body-name: xpath
48
Arpit Singhd6de3f32024-07-09 17:14:02 +0530[diff] [blame]49delta:
Arpit Singh0339c712023-08-02 18:35:31 +0530[diff] [blame]50 get:
51 description: Get delta between two anchors within a given dataspace
52 tags:
53 - cps-data
54 summary: Get delta between anchors in the same dataspace
55 operationId: getDeltaByDataspaceAndAnchors
56 parameters:
57 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
Arpit Singhd6de3f32024-07-09 17:14:02 +0530[diff] [blame]58 - $ref: 'components.yml#/components/parameters/sourceAnchorNameInPath'
Arpit Singh0339c712023-08-02 18:35:31 +0530[diff] [blame]59 - $ref: 'components.yml#/components/parameters/targetAnchorNameInQuery'
60 - $ref: 'components.yml#/components/parameters/xpathInQuery'
61 - $ref: 'components.yml#/components/parameters/descendantsInQuery'
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/deltaReportSample'
72 '400':
73 $ref: 'components.yml#/components/responses/BadRequest'
Arpit Singh0339c712023-08-02 18:35:31 +0530[diff] [blame]74 '403':
75 $ref: 'components.yml#/components/responses/Forbidden'
76 '500':
77 $ref: 'components.yml#/components/responses/InternalServerError'
Arpit Singhd7fa9602023-09-07 17:05:37 +0530[diff] [blame]78 x-codegen-request-body-name: xpath
Arpit Singhd7fa9602023-09-07 17:05:37 +0530[diff] [blame]79 post:
80 description: Get delta between an anchor in a dataspace and JSON payload
81 tags:
82 - cps-data
83 summary: Get delta between an anchor and JSON payload
84 operationId: getDeltaByDataspaceAnchorAndPayload
85 parameters:
86 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
Arpit Singhd6de3f32024-07-09 17:14:02 +0530[diff] [blame]87 - $ref: 'components.yml#/components/parameters/sourceAnchorNameInPath'
Arpit Singhd7fa9602023-09-07 17:05:37 +0530[diff] [blame]88 - $ref: 'components.yml#/components/parameters/xpathInQuery'
89 requestBody:
90 content:
91 multipart/form-data:
92 schema:
93 type: object
94 properties:
95 json:
96 type: object
97 example:
98 test:bookstore:
99 bookstore-name: Chapters
100 categories:
101 - code: 01
102 name: SciFi
103 - code: 02
104 name: kids
105 file:
106 type: string
107 format: binary
108 required:
109 - json
110 responses:
111 '200':
112 description: OK
113 content:
114 application/json:
115 schema:
116 type: object
117 examples:
118 dataSample:
119 $ref: 'components.yml#/components/examples/deltaReportSample'
120 '400':
121 $ref: 'components.yml#/components/responses/BadRequest'
122 '401':
123 $ref: 'components.yml#/components/responses/Unauthorized'
124 '403':
125 $ref: 'components.yml#/components/responses/Forbidden'
126 '500':
127 $ref: 'components.yml#/components/responses/InternalServerError'