Blame - cps-rest/docs/openapi/cpsData.yml - onap/cps

blob: 80d07c806bfe2056381f63e2766c66cb7e74a8d7 [file] [log] [blame]

shivasubedi	8df61a9	2021-06-16 14:43:18 +0100	[diff] [blame]	1	# ============LICENSE_START=======================================================
puthuparambil.aditya	cc17ae5	2022-02-25 13:24:03 +0000	[diff] [blame]	2	# Copyright (c) 2021-2022 Bell Canada.
JosephKeenan	909a850	2022-01-28 10:02:24 +0000	[diff] [blame]	3	# Modifications Copyright (C) 2021-2022 Nordix Foundation
Rudrangi Anupriya	1decb39	2024-06-05 23:55:14 +0530	[diff] [blame]	4	# Modifications Copyright (C) 2022-2024 TechMahindra Ltd.
Michal Jagiello	6ce84d9	2022-12-13 07:40:19 +0000	[diff] [blame]	5	# Modifications Copyright (C) 2022 Deutsche Telekom AG
shivasubedi	8df61a9	2021-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 Kumari	4d52001	2021-08-30 11:50:43 -0400	[diff] [blame]	18	#
				19	# SPDX-License-Identifier: Apache-2.0
shivasubedi	8df61a9	2021-06-16 14:43:18 +0100	[diff] [blame]	20	# ============LICENSE_END=========================================================
				21
DylanB95EST	a79c9f1	2021-10-29 17:33:06 +0100	[diff] [blame]	22	listElementByDataspaceAndAnchor:
Ruslan Kashapov	0905ac1	2021-05-05 13:11:50 +0300	[diff] [blame]	23	post:
DylanB95EST	a79c9f1	2021-10-29 17:33:06 +0100	[diff] [blame]	24	description: Add list element(s) to a list for a given anchor and dataspace
Ruslan Kashapov	0905ac1	2021-05-05 13:11:50 +0300	[diff] [blame]	25	tags:
				26	- cps-data
DylanB95EST	a79c9f1	2021-10-29 17:33:06 +0100	[diff] [blame]	27	summary: Add list element(s)
				28	operationId: addListElements
Ruslan Kashapov	0905ac1	2021-05-05 13:11:50 +0300	[diff] [blame]	29	parameters:
rajesh.kumar	897686f	2022-12-14 08:13:29 +0000	[diff] [blame]	30	- $ref: 'components.yml#/components/parameters/apiVersionInPath'
Ruslan Kashapov	0905ac1	2021-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 puthuparambil	673c6d9	2021-08-24 17:44:34 +0100	[diff] [blame]	34	- $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
Ruslan Kashapov	0905ac1	2021-05-05 13:11:50 +0300	[diff] [blame]	35	requestBody:
				36	required: true
				37	content:
				38	application/json:
				39	schema:
puthuparambil.aditya	5d8b241	2021-11-24 13:35:10 +0000	[diff] [blame]	40	type: object
				41	examples:
puthuparambil.aditya	cc17ae5	2022-02-25 13:24:03 +0000	[diff] [blame]	42	dataSample:
				43	$ref: 'components.yml#/components/examples/dataSample'
Ruslan Kashapov	0905ac1	2021-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 Kashapov	0905ac1	2021-05-05 13:11:50 +0300	[diff] [blame]	49	'403':
				50	$ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan	909a850	2022-01-28 10:02:24 +0000	[diff] [blame]	51	'500':
				52	$ref: 'components.yml#/components/responses/InternalServerError'
Renu Kumari	7edbeb6	2021-08-30 07:45:52 -0400	[diff] [blame]	53	put:
DylanB95EST	a79c9f1	2021-10-29 17:33:06 +0100	[diff] [blame]	54	description: Replace list content under a given parent, anchor and dataspace
Ruslan Kashapov	576f48e	2021-05-14 14:41:05 +0300	[diff] [blame]	55	tags:
				56	- cps-data
DylanB95EST	a79c9f1	2021-10-29 17:33:06 +0100	[diff] [blame]	57	summary: Replace list content
				58	operationId: replaceListContent
Ruslan Kashapov	576f48e	2021-05-14 14:41:05 +0300	[diff] [blame]	59	parameters:
rajesh.kumar	897686f	2022-12-14 08:13:29 +0000	[diff] [blame]	60	- $ref: 'components.yml#/components/parameters/apiVersionInPath'
Ruslan Kashapov	576f48e	2021-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 puthuparambil	673c6d9	2021-08-24 17:44:34 +0100	[diff] [blame]	64	- $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
Ruslan Kashapov	576f48e	2021-05-14 14:41:05 +0300	[diff] [blame]	65	requestBody:
				66	required: true
				67	content:
				68	application/json:
				69	schema:
puthuparambil.aditya	5d8b241	2021-11-24 13:35:10 +0000	[diff] [blame]	70	type: object
				71	examples:
puthuparambil.aditya	cc17ae5	2022-02-25 13:24:03 +0000	[diff] [blame]	72	dataSample:
				73	$ref: 'components.yml#/components/examples/dataSample'
Ruslan Kashapov	576f48e	2021-05-14 14:41:05 +0300	[diff] [blame]	74	responses:
				75	'200':
puthuparambil.aditya	5d8b241	2021-11-24 13:35:10 +0000	[diff] [blame]	76	$ref: 'components.yml#/components/responses/Ok'
Ruslan Kashapov	576f48e	2021-05-14 14:41:05 +0300	[diff] [blame]	77	'400':
				78	$ref: 'components.yml#/components/responses/BadRequest'
Ruslan Kashapov	576f48e	2021-05-14 14:41:05 +0300	[diff] [blame]	79	'403':
				80	$ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan	909a850	2022-01-28 10:02:24 +0000	[diff] [blame]	81	'500':
				82	$ref: 'components.yml#/components/responses/InternalServerError'
lukegleeson	05701dd	2021-08-18 09:49:32 +0100	[diff] [blame]	83
Rishi.Chail	dacc663	2021-01-27 04:27:34 +0000	[diff] [blame]	84	nodesByDataspaceAndAnchor:
niamhcore	74753d9	2021-01-28 16:11:52 +0000	[diff] [blame]	85	post:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	86	description: Create a node for a given anchor and dataspace
niamhcore	74753d9	2021-01-28 16:11:52 +0000	[diff] [blame]	87	tags:
				88	- cps-data
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	89	summary: Create a node
niamhcore	74753d9	2021-01-28 16:11:52 +0000	[diff] [blame]	90	operationId: createNode
				91	parameters:
rajesh.kumar	897686f	2022-12-14 08:13:29 +0000	[diff] [blame]	92	- $ref: 'components.yml#/components/parameters/apiVersionInPath'
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	93	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				94	- $ref: 'components.yml#/components/parameters/anchorNameInPath'
Ruslan Kashapov	24bf350	2021-04-19 12:40:01 +0300	[diff] [blame]	95	- $ref: 'components.yml#/components/parameters/xpathInQuery'
aditya puthuparambil	673c6d9	2021-08-24 17:44:34 +0100	[diff] [blame]	96	- $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
Rudrangi Anupriya	760dd95	2024-07-11 21:56:24 +0530	[diff] [blame]	97	- $ref: 'components.yml#/components/parameters/contentTypeInHeader'
niamhcore	74753d9	2021-01-28 16:11:52 +0000	[diff] [blame]	98	requestBody:
				99	required: true
				100	content:
				101	application/json:
				102	schema:
Michal Jagiello	6ce84d9	2022-12-13 07:40:19 +0000	[diff] [blame]	103	type: string
puthuparambil.aditya	5d8b241	2021-11-24 13:35:10 +0000	[diff] [blame]	104	examples:
puthuparambil.aditya	cc17ae5	2022-02-25 13:24:03 +0000	[diff] [blame]	105	dataSample:
				106	$ref: 'components.yml#/components/examples/dataSample'
Michal Jagiello	6ce84d9	2022-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
niamhcore	74753d9	2021-01-28 16:11:52 +0000	[diff] [blame]	116	responses:
Rishi.Chail	6d13f16	2021-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.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	121	'403':
				122	$ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan	909a850	2022-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 Kashapov	24c72db	2021-02-09 17:25:18 +0200	[diff] [blame]	127	patch:
arpitsingh	2b4c488	2023-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 Kashapov	24c72db	2021-02-09 17:25:18 +0200	[diff] [blame]	130	tags:
				131	- cps-data
				132	summary: Update node leaves
				133	operationId: updateNodeLeaves
				134	parameters:
rajesh.kumar	897686f	2022-12-14 08:13:29 +0000	[diff] [blame]	135	- $ref: 'components.yml#/components/parameters/apiVersionInPath'
Ruslan Kashapov	24c72db	2021-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 puthuparambil	673c6d9	2021-08-24 17:44:34 +0100	[diff] [blame]	139	- $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
Rudrangi Anupriya	760dd95	2024-07-11 21:56:24 +0530	[diff] [blame]	140	- $ref: 'components.yml#/components/parameters/contentTypeInHeader'
Ruslan Kashapov	24c72db	2021-02-09 17:25:18 +0200	[diff] [blame]	141	requestBody:
				142	required: true
				143	content:
				144	application/json:
				145	schema:
Rudrangi Anupriya	1decb39	2024-06-05 23:55:14 +0530	[diff] [blame]	146	type: string
puthuparambil.aditya	5d8b241	2021-11-24 13:35:10 +0000	[diff] [blame]	147	examples:
puthuparambil.aditya	cc17ae5	2022-02-25 13:24:03 +0000	[diff] [blame]	148	dataSample:
				149	$ref: 'components.yml#/components/examples/dataSample'
Rudrangi Anupriya	1decb39	2024-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 Kashapov	24c72db	2021-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 Kashapov	24c72db	2021-02-09 17:25:18 +0200	[diff] [blame]	163	'403':
				164	$ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan	909a850	2022-01-28 10:02:24 +0000	[diff] [blame]	165	'500':
				166	$ref: 'components.yml#/components/responses/InternalServerError'
DylanB95EST	30a59dd	2021-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.kumar	897686f	2022-12-14 08:13:29 +0000	[diff] [blame]	174	- $ref: 'components.yml#/components/parameters/apiVersionInPath'
DylanB95EST	30a59dd	2021-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'
DylanB95EST	30a59dd	2021-11-02 17:25:18 +0000	[diff] [blame]	184	'403':
				185	$ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan	909a850	2022-01-28 10:02:24 +0000	[diff] [blame]	186	'500':
				187	$ref: 'components.yml#/components/responses/InternalServerError'
Ruslan Kashapov	24c72db	2021-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.kumar	897686f	2022-12-14 08:13:29 +0000	[diff] [blame]	195	- $ref: 'components.yml#/components/parameters/apiVersionInPath'
Ruslan Kashapov	24c72db	2021-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 puthuparambil	673c6d9	2021-08-24 17:44:34 +0100	[diff] [blame]	199	- $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
Rudrangi Anupriya	760dd95	2024-07-11 21:56:24 +0530	[diff] [blame]	200	- $ref: 'components.yml#/components/parameters/contentTypeInHeader'
Ruslan Kashapov	24c72db	2021-02-09 17:25:18 +0200	[diff] [blame]	201	requestBody:
				202	required: true
				203	content:
				204	application/json:
				205	schema:
Rudrangi Anupriya	760dd95	2024-07-11 21:56:24 +0530	[diff] [blame]	206	type: string
puthuparambil.aditya	5d8b241	2021-11-24 13:35:10 +0000	[diff] [blame]	207	examples:
puthuparambil.aditya	cc17ae5	2022-02-25 13:24:03 +0000	[diff] [blame]	208	dataSample:
				209	$ref: 'components.yml#/components/examples/dataSample'
Rudrangi Anupriya	760dd95	2024-07-11 21:56:24 +0530	[diff] [blame]	210	application/xml:
				211	schema:
				212	type: object
				213	xml:
				214	name: stores
				215	examples:
				216	dataSample:
				217	$ref: 'components.yml#/components/examples/dataSampleXml'
Ruslan Kashapov	24c72db	2021-02-09 17:25:18 +0200	[diff] [blame]	218	responses:
				219	'200':
				220	$ref: 'components.yml#/components/responses/Ok'
				221	'400':
				222	$ref: 'components.yml#/components/responses/BadRequest'
Ruslan Kashapov	24c72db	2021-02-09 17:25:18 +0200	[diff] [blame]	223	'403':
DylanB95EST	a79c9f1	2021-10-29 17:33:06 +0100	[diff] [blame]	224	$ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan	909a850	2022-01-28 10:02:24 +0000	[diff] [blame]	225	'500':
				226	$ref: 'components.yml#/components/responses/InternalServerError'