Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / 1decb39aa016bdfc7ac870aec738c9c08484c32f / . / cps-rest / docs / openapi / cpsData.yml
blob: d13c28581707dba2a1536899857cefb932b535d9 [file] [log] [blame]
shivasubedi8df61a92021-06-16 14:43:18 +0100[diff] [blame]1# ============LICENSE_START=======================================================
puthuparambil.adityacc17ae52022-02-25 13:24:03 +0000[diff] [blame]2# Copyright (c) 2021-2022 Bell Canada.
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]3# Modifications Copyright (C) 2021-2022 Nordix Foundation
Rudrangi Anupriya1decb392024-06-05 23:55:14 +0530[diff] [blame^]4# Modifications Copyright (C) 2022-2024 TechMahindra Ltd.
Michal Jagiello6ce84d92022-12-13 07:40:19 +0000[diff] [blame]5# Modifications Copyright (C) 2022 Deutsche Telekom AG
shivasubedi8df61a92021-06-16 14:43:18 +0100[diff] [blame]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
10#
11# http://www.apache.org/licenses/LICENSE-2.0
12#
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.
Renu Kumari4d520012021-08-30 11:50:43 -0400[diff] [blame]18#
19# SPDX-License-Identifier: Apache-2.0
shivasubedi8df61a92021-06-16 14:43:18 +0100[diff] [blame]20# ============LICENSE_END=========================================================
21
DylanB95ESTa79c9f12021-10-29 17:33:06 +0100[diff] [blame]22listElementByDataspaceAndAnchor:
Ruslan Kashapov0905ac12021-05-05 13:11:50 +0300[diff] [blame]23 post:
DylanB95ESTa79c9f12021-10-29 17:33:06 +0100[diff] [blame]24 description: Add list element(s) to a list for a given anchor and dataspace
Ruslan Kashapov0905ac12021-05-05 13:11:50 +0300[diff] [blame]25 tags:
26 - cps-data
DylanB95ESTa79c9f12021-10-29 17:33:06 +0100[diff] [blame]27 summary: Add list element(s)
28 operationId: addListElements
Ruslan Kashapov0905ac12021-05-05 13:11:50 +0300[diff] [blame]29 parameters:
rajesh.kumar897686f2022-12-14 08:13:29 +0000[diff] [blame]30 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
Ruslan Kashapov0905ac12021-05-05 13:11:50 +0300[diff] [blame]31 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
32 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
33 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
aditya puthuparambil673c6d92021-08-24 17:44:34 +0100[diff] [blame]34 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
Ruslan Kashapov0905ac12021-05-05 13:11:50 +0300[diff] [blame]35 requestBody:
36 required: true
37 content:
38 application/json:
39 schema:
puthuparambil.aditya5d8b2412021-11-24 13:35:10 +0000[diff] [blame]40 type: object
41 examples:
puthuparambil.adityacc17ae52022-02-25 13:24:03 +0000[diff] [blame]42 dataSample:
43 $ref: 'components.yml#/components/examples/dataSample'
Ruslan Kashapov0905ac12021-05-05 13:11:50 +0300[diff] [blame]44 responses:
45 '201':
46 $ref: 'components.yml#/components/responses/Created'
47 '400':
48 $ref: 'components.yml#/components/responses/BadRequest'
Ruslan Kashapov0905ac12021-05-05 13:11:50 +0300[diff] [blame]49 '403':
50 $ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]51 '500':
52 $ref: 'components.yml#/components/responses/InternalServerError'
Renu Kumari7edbeb62021-08-30 07:45:52 -0400[diff] [blame]53 put:
DylanB95ESTa79c9f12021-10-29 17:33:06 +0100[diff] [blame]54 description: Replace list content under a given parent, anchor and dataspace
Ruslan Kashapov576f48e2021-05-14 14:41:05 +0300[diff] [blame]55 tags:
56 - cps-data
DylanB95ESTa79c9f12021-10-29 17:33:06 +0100[diff] [blame]57 summary: Replace list content
58 operationId: replaceListContent
Ruslan Kashapov576f48e2021-05-14 14:41:05 +0300[diff] [blame]59 parameters:
rajesh.kumar897686f2022-12-14 08:13:29 +0000[diff] [blame]60 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
Ruslan Kashapov576f48e2021-05-14 14:41:05 +0300[diff] [blame]61 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
62 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
63 - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
aditya puthuparambil673c6d92021-08-24 17:44:34 +0100[diff] [blame]64 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
Ruslan Kashapov576f48e2021-05-14 14:41:05 +0300[diff] [blame]65 requestBody:
66 required: true
67 content:
68 application/json:
69 schema:
puthuparambil.aditya5d8b2412021-11-24 13:35:10 +0000[diff] [blame]70 type: object
71 examples:
puthuparambil.adityacc17ae52022-02-25 13:24:03 +0000[diff] [blame]72 dataSample:
73 $ref: 'components.yml#/components/examples/dataSample'
Ruslan Kashapov576f48e2021-05-14 14:41:05 +0300[diff] [blame]74 responses:
75 '200':
puthuparambil.aditya5d8b2412021-11-24 13:35:10 +0000[diff] [blame]76 $ref: 'components.yml#/components/responses/Ok'
Ruslan Kashapov576f48e2021-05-14 14:41:05 +0300[diff] [blame]77 '400':
78 $ref: 'components.yml#/components/responses/BadRequest'
Ruslan Kashapov576f48e2021-05-14 14:41:05 +0300[diff] [blame]79 '403':
80 $ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]81 '500':
82 $ref: 'components.yml#/components/responses/InternalServerError'
lukegleeson05701dd2021-08-18 09:49:32 +0100[diff] [blame]83
Rishi.Chaildacc6632021-01-27 04:27:34 +0000[diff] [blame]84nodesByDataspaceAndAnchor:
niamhcore74753d92021-01-28 16:11:52 +0000[diff] [blame]85 post:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]86 description: Create a node for a given anchor and dataspace
niamhcore74753d92021-01-28 16:11:52 +0000[diff] [blame]87 tags:
88 - cps-data
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]89 summary: Create a node
niamhcore74753d92021-01-28 16:11:52 +0000[diff] [blame]90 operationId: createNode
91 parameters:
rajesh.kumar897686f2022-12-14 08:13:29 +0000[diff] [blame]92 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]93 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
94 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
Ruslan Kashapov24bf3502021-04-19 12:40:01 +0300[diff] [blame]95 - $ref: 'components.yml#/components/parameters/xpathInQuery'
aditya puthuparambil673c6d92021-08-24 17:44:34 +0100[diff] [blame]96 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
Michal Jagiello6ce84d92022-12-13 07:40:19 +0000[diff] [blame]97 - $ref: 'components.yml#/components/parameters/contentTypeHeader'
niamhcore74753d92021-01-28 16:11:52 +0000[diff] [blame]98 requestBody:
99 required: true
100 content:
101 application/json:
102 schema:
Michal Jagiello6ce84d92022-12-13 07:40:19 +0000[diff] [blame]103 type: string
puthuparambil.aditya5d8b2412021-11-24 13:35:10 +0000[diff] [blame]104 examples:
puthuparambil.adityacc17ae52022-02-25 13:24:03 +0000[diff] [blame]105 dataSample:
106 $ref: 'components.yml#/components/examples/dataSample'
Michal Jagiello6ce84d92022-12-13 07:40:19 +0000[diff] [blame]107 application/xml:
108 schema:
109 type: object # Workaround to show example
110 xml:
111 name: stores
112 examples:
113 dataSample:
114 $ref: 'components.yml#/components/examples/dataSampleXml'
115
niamhcore74753d92021-01-28 16:11:52 +0000[diff] [blame]116 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]117 '201':
118 $ref: 'components.yml#/components/responses/Created'
119 '400':
120 $ref: 'components.yml#/components/responses/BadRequest'
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]121 '403':
122 $ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]123 '409':
124 $ref: 'components.yml#/components/responses/Conflict'
125 '500':
126 $ref: 'components.yml#/components/responses/InternalServerError'
Ruslan Kashapov24c72db2021-02-09 17:25:18 +0200[diff] [blame]127 patch:
arpitsingh2b4c4882023-03-03 21:38:57 +0530[diff] [blame]128 description: Update a data node leaves for a given dataspace and anchor and a parent node xpath. This operation
129 is currently supported for one top level data node only.
Ruslan Kashapov24c72db2021-02-09 17:25:18 +0200[diff] [blame]130 tags:
131 - cps-data
132 summary: Update node leaves
133 operationId: updateNodeLeaves
134 parameters:
rajesh.kumar897686f2022-12-14 08:13:29 +0000[diff] [blame]135 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
Ruslan Kashapov24c72db2021-02-09 17:25:18 +0200[diff] [blame]136 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
137 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
138 - $ref: 'components.yml#/components/parameters/xpathInQuery'
aditya puthuparambil673c6d92021-08-24 17:44:34 +0100[diff] [blame]139 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
Rudrangi Anupriya1decb392024-06-05 23:55:14 +0530[diff] [blame^]140 - $ref: 'components.yml#/components/parameters/contentTypeHeader'
Ruslan Kashapov24c72db2021-02-09 17:25:18 +0200[diff] [blame]141 requestBody:
142 required: true
143 content:
144 application/json:
145 schema:
Rudrangi Anupriya1decb392024-06-05 23:55:14 +0530[diff] [blame^]146 type: string
puthuparambil.aditya5d8b2412021-11-24 13:35:10 +0000[diff] [blame]147 examples:
puthuparambil.adityacc17ae52022-02-25 13:24:03 +0000[diff] [blame]148 dataSample:
149 $ref: 'components.yml#/components/examples/dataSample'
Rudrangi Anupriya1decb392024-06-05 23:55:14 +0530[diff] [blame^]150 application/xml:
151 schema:
152 type: object
153 xml:
154 name: stores
155 examples:
156 dataSample:
157 $ref: 'components.yml#/components/examples/dataSampleXml'
Ruslan Kashapov24c72db2021-02-09 17:25:18 +0200[diff] [blame]158 responses:
159 '200':
160 $ref: 'components.yml#/components/responses/Ok'
161 '400':
162 $ref: 'components.yml#/components/responses/BadRequest'
Ruslan Kashapov24c72db2021-02-09 17:25:18 +0200[diff] [blame]163 '403':
164 $ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]165 '500':
166 $ref: 'components.yml#/components/responses/InternalServerError'
DylanB95EST30a59dd2021-11-02 17:25:18 +0000[diff] [blame]167 delete:
168 description: Delete a datanode for a given dataspace and anchor given a node xpath.
169 tags:
170 - cps-data
171 summary: Delete a data node
172 operationId: deleteDataNode
173 parameters:
rajesh.kumar897686f2022-12-14 08:13:29 +0000[diff] [blame]174 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
DylanB95EST30a59dd2021-11-02 17:25:18 +0000[diff] [blame]175 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
176 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
177 - $ref: 'components.yml#/components/parameters/xpathInQuery'
178 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
179 responses:
180 '204':
181 $ref: 'components.yml#/components/responses/NoContent'
182 '400':
183 $ref: 'components.yml#/components/responses/BadRequest'
DylanB95EST30a59dd2021-11-02 17:25:18 +0000[diff] [blame]184 '403':
185 $ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]186 '500':
187 $ref: 'components.yml#/components/responses/InternalServerError'
Ruslan Kashapov24c72db2021-02-09 17:25:18 +0200[diff] [blame]188 put:
189 description: Replace a node with descendants for a given dataspace, anchor and a parent node xpath
190 tags:
191 - cps-data
192 summary: Replace a node with descendants
193 operationId: replaceNode
194 parameters:
rajesh.kumar897686f2022-12-14 08:13:29 +0000[diff] [blame]195 - $ref: 'components.yml#/components/parameters/apiVersionInPath'
Ruslan Kashapov24c72db2021-02-09 17:25:18 +0200[diff] [blame]196 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
197 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
198 - $ref: 'components.yml#/components/parameters/xpathInQuery'
aditya puthuparambil673c6d92021-08-24 17:44:34 +0100[diff] [blame]199 - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
Ruslan Kashapov24c72db2021-02-09 17:25:18 +0200[diff] [blame]200 requestBody:
201 required: true
202 content:
203 application/json:
204 schema:
puthuparambil.aditya5d8b2412021-11-24 13:35:10 +0000[diff] [blame]205 type: object
206 examples:
puthuparambil.adityacc17ae52022-02-25 13:24:03 +0000[diff] [blame]207 dataSample:
208 $ref: 'components.yml#/components/examples/dataSample'
Ruslan Kashapov24c72db2021-02-09 17:25:18 +0200[diff] [blame]209 responses:
210 '200':
211 $ref: 'components.yml#/components/responses/Ok'
212 '400':
213 $ref: 'components.yml#/components/responses/BadRequest'
Ruslan Kashapov24c72db2021-02-09 17:25:18 +0200[diff] [blame]214 '403':
DylanB95ESTa79c9f12021-10-29 17:33:06 +0100[diff] [blame]215 $ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan909a8502022-01-28 10:02:24 +0000[diff] [blame]216 '500':
217 $ref: 'components.yml#/components/responses/InternalServerError'