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

blob: 1e70ef60c87130c9d4c5587f4f4879c972943f8b [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'
niamhcore	74753d9	2021-01-28 16:11:52 +0000	[diff] [blame]	115	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	116	'201':
				117	$ref: 'components.yml#/components/responses/Created'
				118	'400':
				119	$ref: 'components.yml#/components/responses/BadRequest'
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	120	'403':
				121	$ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan	909a850	2022-01-28 10:02:24 +0000	[diff] [blame]	122	'409':
				123	$ref: 'components.yml#/components/responses/Conflict'
				124	'500':
				125	$ref: 'components.yml#/components/responses/InternalServerError'
Ruslan Kashapov	24c72db	2021-02-09 17:25:18 +0200	[diff] [blame]	126	patch:
arpitsingh	2b4c488	2023-03-03 21:38:57 +0530	[diff] [blame]	127	description: Update a data node leaves for a given dataspace and anchor and a parent node xpath. This operation
				128	is currently supported for one top level data node only.
Ruslan Kashapov	24c72db	2021-02-09 17:25:18 +0200	[diff] [blame]	129	tags:
				130	- cps-data
				131	summary: Update node leaves
				132	operationId: updateNodeLeaves
				133	parameters:
rajesh.kumar	897686f	2022-12-14 08:13:29 +0000	[diff] [blame]	134	- $ref: 'components.yml#/components/parameters/apiVersionInPath'
Ruslan Kashapov	24c72db	2021-02-09 17:25:18 +0200	[diff] [blame]	135	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				136	- $ref: 'components.yml#/components/parameters/anchorNameInPath'
				137	- $ref: 'components.yml#/components/parameters/xpathInQuery'
aditya puthuparambil	673c6d9	2021-08-24 17:44:34 +0100	[diff] [blame]	138	- $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
Rudrangi Anupriya	760dd95	2024-07-11 21:56:24 +0530	[diff] [blame]	139	- $ref: 'components.yml#/components/parameters/contentTypeInHeader'
Ruslan Kashapov	24c72db	2021-02-09 17:25:18 +0200	[diff] [blame]	140	requestBody:
				141	required: true
				142	content:
				143	application/json:
				144	schema:
Rudrangi Anupriya	1decb39	2024-06-05 23:55:14 +0530	[diff] [blame]	145	type: string
puthuparambil.aditya	5d8b241	2021-11-24 13:35:10 +0000	[diff] [blame]	146	examples:
puthuparambil.aditya	cc17ae5	2022-02-25 13:24:03 +0000	[diff] [blame]	147	dataSample:
				148	$ref: 'components.yml#/components/examples/dataSample'
Rudrangi Anupriya	1decb39	2024-06-05 23:55:14 +0530	[diff] [blame]	149	application/xml:
				150	schema:
				151	type: object
				152	xml:
				153	name: stores
				154	examples:
				155	dataSample:
				156	$ref: 'components.yml#/components/examples/dataSampleXml'
Ruslan Kashapov	24c72db	2021-02-09 17:25:18 +0200	[diff] [blame]	157	responses:
				158	'200':
				159	$ref: 'components.yml#/components/responses/Ok'
				160	'400':
				161	$ref: 'components.yml#/components/responses/BadRequest'
Ruslan Kashapov	24c72db	2021-02-09 17:25:18 +0200	[diff] [blame]	162	'403':
				163	$ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan	909a850	2022-01-28 10:02:24 +0000	[diff] [blame]	164	'500':
				165	$ref: 'components.yml#/components/responses/InternalServerError'
DylanB95EST	30a59dd	2021-11-02 17:25:18 +0000	[diff] [blame]	166	delete:
				167	description: Delete a datanode for a given dataspace and anchor given a node xpath.
				168	tags:
				169	- cps-data
				170	summary: Delete a data node
				171	operationId: deleteDataNode
				172	parameters:
rajesh.kumar	897686f	2022-12-14 08:13:29 +0000	[diff] [blame]	173	- $ref: 'components.yml#/components/parameters/apiVersionInPath'
DylanB95EST	30a59dd	2021-11-02 17:25:18 +0000	[diff] [blame]	174	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				175	- $ref: 'components.yml#/components/parameters/anchorNameInPath'
				176	- $ref: 'components.yml#/components/parameters/xpathInQuery'
				177	- $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
				178	responses:
				179	'204':
				180	$ref: 'components.yml#/components/responses/NoContent'
				181	'400':
				182	$ref: 'components.yml#/components/responses/BadRequest'
DylanB95EST	30a59dd	2021-11-02 17:25:18 +0000	[diff] [blame]	183	'403':
				184	$ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan	909a850	2022-01-28 10:02:24 +0000	[diff] [blame]	185	'500':
				186	$ref: 'components.yml#/components/responses/InternalServerError'
Ruslan Kashapov	24c72db	2021-02-09 17:25:18 +0200	[diff] [blame]	187	put:
				188	description: Replace a node with descendants for a given dataspace, anchor and a parent node xpath
				189	tags:
				190	- cps-data
				191	summary: Replace a node with descendants
				192	operationId: replaceNode
				193	parameters:
rajesh.kumar	897686f	2022-12-14 08:13:29 +0000	[diff] [blame]	194	- $ref: 'components.yml#/components/parameters/apiVersionInPath'
Ruslan Kashapov	24c72db	2021-02-09 17:25:18 +0200	[diff] [blame]	195	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				196	- $ref: 'components.yml#/components/parameters/anchorNameInPath'
				197	- $ref: 'components.yml#/components/parameters/xpathInQuery'
aditya puthuparambil	673c6d9	2021-08-24 17:44:34 +0100	[diff] [blame]	198	- $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
Rudrangi Anupriya	760dd95	2024-07-11 21:56:24 +0530	[diff] [blame]	199	- $ref: 'components.yml#/components/parameters/contentTypeInHeader'
Ruslan Kashapov	24c72db	2021-02-09 17:25:18 +0200	[diff] [blame]	200	requestBody:
				201	required: true
				202	content:
				203	application/json:
				204	schema:
Rudrangi Anupriya	760dd95	2024-07-11 21:56:24 +0530	[diff] [blame]	205	type: string
puthuparambil.aditya	5d8b241	2021-11-24 13:35:10 +0000	[diff] [blame]	206	examples:
puthuparambil.aditya	cc17ae5	2022-02-25 13:24:03 +0000	[diff] [blame]	207	dataSample:
				208	$ref: 'components.yml#/components/examples/dataSample'
Rudrangi Anupriya	760dd95	2024-07-11 21:56:24 +0530	[diff] [blame]	209	application/xml:
				210	schema:
				211	type: object
				212	xml:
				213	name: stores
				214	examples:
				215	dataSample:
				216	$ref: 'components.yml#/components/examples/dataSampleXml'
Ruslan Kashapov	24c72db	2021-02-09 17:25:18 +0200	[diff] [blame]	217	responses:
				218	'200':
				219	$ref: 'components.yml#/components/responses/Ok'
				220	'400':
				221	$ref: 'components.yml#/components/responses/BadRequest'
Ruslan Kashapov	24c72db	2021-02-09 17:25:18 +0200	[diff] [blame]	222	'403':
DylanB95EST	a79c9f1	2021-10-29 17:33:06 +0100	[diff] [blame]	223	$ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan	909a850	2022-01-28 10:02:24 +0000	[diff] [blame]	224	'500':
				225	$ref: 'components.yml#/components/responses/InternalServerError'