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

blob: f394270dd596c976d188e776284421b1b46764ce [file] [log] [blame]

shivasubedi	8df61a9	2021-06-16 14:43:18 +0100	[diff] [blame]	1	# ============LICENSE_START=======================================================
				2	# Copyright (c) 2021 Bell Canada.
JosephKeenan	909a850	2022-01-28 10:02:24 +0000	[diff] [blame]	3	# Modifications Copyright (C) 2021-2022 Nordix Foundation
rajesh.kumar	cec0cb7	2022-09-06 11:47:18 +0000	[diff] [blame]	4	# Modifications Copyright (C) 2022 TechMahindra Ltd.
shivasubedi	8df61a9	2021-06-16 14:43:18 +0100	[diff] [blame]	5	# ================================================================================
				6	# Licensed under the Apache License, Version 2.0 (the "License");
				7	# you may not use this file except in compliance with the License.
				8	# You may obtain a copy of the License at
				9	#
				10	# http://www.apache.org/licenses/LICENSE-2.0
				11	#
				12	# Unless required by applicable law or agreed to in writing, software
				13	# distributed under the License is distributed on an "AS IS" BASIS,
				14	# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
				15	# See the License for the specific language governing permissions and
				16	# limitations under the License.
Renu Kumari	4d52001	2021-08-30 11:50:43 -0400	[diff] [blame]	17	#
				18	# SPDX-License-Identifier: Apache-2.0
shivasubedi	8df61a9	2021-06-16 14:43:18 +0100	[diff] [blame]	19	# ============LICENSE_END=========================================================
				20
Rishi.Chail	dacc663	2021-01-27 04:27:34 +0000	[diff] [blame]	21	dataspaces:
niamhcore	09c6b6e	2021-11-22 11:44:38 +0000	[diff] [blame]	22	delete:
				23	description: Delete a dataspace
				24	tags:
				25	- cps-admin
				26	summary: Delete a dataspace
				27	operationId: deleteDataspace
				28	parameters:
rajesh.kumar	897686f	2022-12-14 08:13:29 +0000	[diff] [blame]	29	- $ref: 'components.yml#/components/parameters/apiVersionInPath'
niamhcore	09c6b6e	2021-11-22 11:44:38 +0000	[diff] [blame]	30	- $ref: 'components.yml#/components/parameters/dataspaceNameInQuery'
				31	responses:
				32	'204':
				33	$ref: 'components.yml#/components/responses/NoContent'
				34	'400':
				35	$ref: 'components.yml#/components/responses/BadRequest'
niamhcore	09c6b6e	2021-11-22 11:44:38 +0000	[diff] [blame]	36	'403':
				37	$ref: 'components.yml#/components/responses/Forbidden'
				38	'409':
				39	$ref: 'components.yml#/components/responses/Conflict'
JosephKeenan	909a850	2022-01-28 10:02:24 +0000	[diff] [blame]	40	'500':
				41	$ref: 'components.yml#/components/responses/InternalServerError'
niamhcore	09c6b6e	2021-11-22 11:44:38 +0000	[diff] [blame]	42
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	43	schemaSet:
rajesh.kumar	71e4f83	2022-09-14 05:11:32 +0000	[diff] [blame]	44	get:
				45	description: Read all schema sets, given a dataspace
				46	tags:
				47	- cps-admin
				48	summary: Get schema sets
				49	operationId: getSchemaSets
				50	parameters:
rajesh.kumar	897686f	2022-12-14 08:13:29 +0000	[diff] [blame]	51	- $ref: 'components.yml#/components/parameters/apiVersionInPath'
rajesh.kumar	71e4f83	2022-09-14 05:11:32 +0000	[diff] [blame]	52	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				53	responses:
				54	'200':
				55	description: OK
				56	content:
				57	application/json:
				58	schema:
				59	type: array
				60	items:
				61	$ref: 'components.yml#/components/schemas/SchemaSetDetails'
				62	'400':
				63	$ref: 'components.yml#/components/responses/BadRequest'
rajesh.kumar	71e4f83	2022-09-14 05:11:32 +0000	[diff] [blame]	64	'403':
				65	$ref: 'components.yml#/components/responses/Forbidden'
				66	'500':
				67	$ref: 'components.yml#/components/responses/InternalServerError'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	68
				69	schemaSetBySchemaSetName:
				70	get:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	71	description: Read a schema set given a schema set name and a dataspace
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	72	tags:
				73	- cps-admin
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	74	summary: Get a schema set
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	75	operationId: getSchemaSet
				76	parameters:
rajesh.kumar	897686f	2022-12-14 08:13:29 +0000	[diff] [blame]	77	- $ref: 'components.yml#/components/parameters/apiVersionInPath'
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	78	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				79	- $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	80	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	81	'200':
JosephKeenan	c6865f3	2021-06-08 13:16:37 +0100	[diff] [blame]	82	description: OK
				83	content:
				84	application/json:
				85	schema:
				86	$ref: 'components.yml#/components/schemas/SchemaSetDetails'
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	87	'400':
				88	$ref: 'components.yml#/components/responses/BadRequest'
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	89	'403':
				90	$ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan	909a850	2022-01-28 10:02:24 +0000	[diff] [blame]	91	'500':
				92	$ref: 'components.yml#/components/responses/InternalServerError'
Ruslan Kashapov	dce4e31	2021-01-11 15:34:10 +0200	[diff] [blame]	93	delete:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	94	description: Delete a schema set given a schema set name and a dataspace
Ruslan Kashapov	dce4e31	2021-01-11 15:34:10 +0200	[diff] [blame]	95	tags:
				96	- cps-admin
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	97	summary: Delete a schema set
Ruslan Kashapov	dce4e31	2021-01-11 15:34:10 +0200	[diff] [blame]	98	operationId: deleteSchemaSet
				99	parameters:
rajesh.kumar	897686f	2022-12-14 08:13:29 +0000	[diff] [blame]	100	- $ref: 'components.yml#/components/parameters/apiVersionInPath'
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	101	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				102	- $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
Ruslan Kashapov	dce4e31	2021-01-11 15:34:10 +0200	[diff] [blame]	103	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	104	'204':
				105	$ref: 'components.yml#/components/responses/NoContent'
				106	'400':
				107	$ref: 'components.yml#/components/responses/BadRequest'
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	108	'403':
				109	$ref: 'components.yml#/components/responses/Forbidden'
				110	'409':
				111	$ref: 'components.yml#/components/responses/Conflict'
JosephKeenan	909a850	2022-01-28 10:02:24 +0000	[diff] [blame]	112	'500':
				113	$ref: 'components.yml#/components/responses/InternalServerError'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	114
				115	anchorsByDataspace:
				116	get:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	117	description: Read all anchors, given a dataspace
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	118	tags:
				119	- cps-admin
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	120	summary: Get anchors
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	121	operationId: getAnchors
				122	parameters:
rajesh.kumar	897686f	2022-12-14 08:13:29 +0000	[diff] [blame]	123	- $ref: 'components.yml#/components/parameters/apiVersionInPath'
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	124	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	125	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	126	'200':
JosephKeenan	c6865f3	2021-06-08 13:16:37 +0100	[diff] [blame]	127	description: OK
				128	content:
				129	application/json:
				130	schema:
				131	type: array
				132	items:
				133	$ref: 'components.yml#/components/schemas/AnchorDetails'
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	134	'400':
				135	$ref: 'components.yml#/components/responses/BadRequest'
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	136	'403':
				137	$ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan	909a850	2022-01-28 10:02:24 +0000	[diff] [blame]	138	'500':
				139	$ref: 'components.yml#/components/responses/InternalServerError'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	140
				141	anchorByDataspaceAndAnchorName:
				142	get:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	143	description: Read an anchor given an anchor name and a dataspace
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	144	tags:
				145	- cps-admin
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	146	summary: Get an anchor
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	147	operationId: getAnchor
				148	parameters:
rajesh.kumar	897686f	2022-12-14 08:13:29 +0000	[diff] [blame]	149	- $ref: 'components.yml#/components/parameters/apiVersionInPath'
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	150	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				151	- $ref: 'components.yml#/components/parameters/anchorNameInPath'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	152	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	153	'200':
JosephKeenan	c6865f3	2021-06-08 13:16:37 +0100	[diff] [blame]	154	description: OK
				155	content:
				156	application/json:
				157	schema:
				158	$ref: 'components.yml#/components/schemas/AnchorDetails'
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	159	'400':
				160	$ref: 'components.yml#/components/responses/BadRequest'
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	161	'403':
				162	$ref: 'components.yml#/components/responses/Forbidden'
JosephKeenan	909a850	2022-01-28 10:02:24 +0000	[diff] [blame]	163	'500':
				164	$ref: 'components.yml#/components/responses/InternalServerError'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	165	delete:
Ruslan Kashapov	b20858b	2021-04-05 14:46:03 +0300	[diff] [blame]	166	description: Delete an anchor given an anchor name and a dataspace
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	167	tags:
				168	- cps-admin
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	169	summary: Delete an anchor
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	170	operationId: deleteAnchor
				171	parameters:
rajesh.kumar	897686f	2022-12-14 08:13:29 +0000	[diff] [blame]	172	- $ref: 'components.yml#/components/parameters/apiVersionInPath'
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	173	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				174	- $ref: 'components.yml#/components/parameters/anchorNameInPath'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	175	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	176	'204':
				177	$ref: 'components.yml#/components/responses/NoContent'
				178	'400':
				179	$ref: 'components.yml#/components/responses/BadRequest'
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	180	'403':
JosephKeenan	909a850	2022-01-28 10:02:24 +0000	[diff] [blame]	181	$ref: 'components.yml#/components/responses/Forbidden'
				182	'500':
rajesh.kumar	cec0cb7	2022-09-06 11:47:18 +0000	[diff] [blame]	183	$ref: 'components.yml#/components/responses/InternalServerError'
				184
				185	adminDataspaces:
				186	get:
				187	description: Read all dataspaces
				188	tags:
				189	- cps-admin
				190	summary: Get all dataspaces
				191	operationId: getAllDataspaces
rajesh.kumar	897686f	2022-12-14 08:13:29 +0000	[diff] [blame]	192	parameters:
				193	- $ref: 'components.yml#/components/parameters/apiVersionInPath'
rajesh.kumar	cec0cb7	2022-09-06 11:47:18 +0000	[diff] [blame]	194	responses:
				195	'200':
				196	description: OK
				197	content:
				198	application/json:
				199	schema:
				200	type: array
				201	items:
				202	$ref: 'components.yml#/components/schemas/DataspaceDetails'
				203	'400':
				204	$ref: 'components.yml#/components/responses/BadRequest'
rajesh.kumar	cec0cb7	2022-09-06 11:47:18 +0000	[diff] [blame]	205	'403':
				206	$ref: 'components.yml#/components/responses/Forbidden'
				207	'500':
				208	$ref: 'components.yml#/components/responses/InternalServerError'
				209
				210	adminDataspace:
				211	get:
				212	description: Read a dataspace given a dataspace name
				213	tags:
				214	- cps-admin
				215	summary: Get a dataspace
				216	operationId: getDataspace
				217	parameters:
rajesh.kumar	897686f	2022-12-14 08:13:29 +0000	[diff] [blame]	218	- $ref: 'components.yml#/components/parameters/apiVersionInPath'
rajesh.kumar	cec0cb7	2022-09-06 11:47:18 +0000	[diff] [blame]	219	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				220	responses:
				221	'200':
				222	description: OK
				223	content:
				224	application/json:
				225	schema:
				226	$ref: 'components.yml#/components/schemas/DataspaceDetails'
				227	'400':
				228	$ref: 'components.yml#/components/responses/BadRequest'
rajesh.kumar	cec0cb7	2022-09-06 11:47:18 +0000	[diff] [blame]	229	'403':
				230	$ref: 'components.yml#/components/responses/Forbidden'
				231	'500':
				232	$ref: 'components.yml#/components/responses/InternalServerError'