Blame - cps-rest/docs/api/swagger/cpsAdmin.yml - onap/cps

blob: 5040e2cf8d21f30de14b7c5de2998097cb3d9e2b [file] [log] [blame]

Rishi.Chail	dacc663	2021-01-27 04:27:34 +0000	[diff] [blame]	1	dataspaces:
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	2	post:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	3	description: Create a new dataspace
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	4	tags:
				5	- cps-admin
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	6	summary: Create a dataspace
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	7	operationId: createDataspace
				8	parameters:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	9	- $ref: 'components.yml#/components/parameters/dataspaceNameInQuery'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	10	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	11	'201':
				12	$ref: 'components.yml#/components/responses/Created'
				13	'400':
				14	$ref: 'components.yml#/components/responses/BadRequest'
				15	'401':
				16	$ref: 'components.yml#/components/responses/Unauthorized'
				17	'403':
				18	$ref: 'components.yml#/components/responses/Forbidden'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	19
				20	dataspaceByDataspaceName:
				21	delete:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	22	description: Delete the given dataspace - DRAFT
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	23	tags:
				24	- cps-admin
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	25	summary: Delete a dataspace
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	26	operationId: deleteDataspace
				27	parameters:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	28	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	29	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	30	'200':
				31	$ref: 'components.yml#/components/responses/Ok'
				32	'204':
				33	$ref: 'components.yml#/components/responses/NoContent'
				34	'400':
				35	$ref: 'components.yml#/components/responses/BadRequest'
				36	'401':
				37	$ref: 'components.yml#/components/responses/Unauthorized'
				38	'403':
				39	$ref: 'components.yml#/components/responses/Forbidden'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	40
				41
				42	schemaSet:
				43	post:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	44	description: Create a new schema set in the given dataspace
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	45	tags:
				46	- cps-admin
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	47	summary: Create a schema set
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	48	operationId: createSchemaSet
				49	parameters:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	50	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				51	- $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	52	requestBody:
				53	required: true
				54	content:
				55	multipart/form-data:
				56	schema:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	57	$ref: 'components.yml#/components/schemas/MultipartFile'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	58
				59	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	60	'201':
				61	$ref: 'components.yml#/components/responses/Created'
				62	'400':
				63	$ref: 'components.yml#/components/responses/BadRequest'
				64	'401':
				65	$ref: 'components.yml#/components/responses/Unauthorized'
				66	'403':
				67	$ref: 'components.yml#/components/responses/Forbidden'
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:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	77	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				78	- $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	79	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	80	'200':
				81	$ref: 'components.yml#/components/responses/Ok'
				82	'400':
				83	$ref: 'components.yml#/components/responses/BadRequest'
				84	'401':
				85	$ref: 'components.yml#/components/responses/Unauthorized'
				86	'403':
				87	$ref: 'components.yml#/components/responses/Forbidden'
				88	'404':
				89	$ref: 'components.yml#/components/responses/NotFound'
				90
Ruslan Kashapov	dce4e31	2021-01-11 15:34:10 +0200	[diff] [blame]	91	delete:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	92	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]	93	tags:
				94	- cps-admin
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	95	summary: Delete a schema set
Ruslan Kashapov	dce4e31	2021-01-11 15:34:10 +0200	[diff] [blame]	96	operationId: deleteSchemaSet
				97	parameters:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	98	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				99	- $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
Ruslan Kashapov	dce4e31	2021-01-11 15:34:10 +0200	[diff] [blame]	100	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	101	'204':
				102	$ref: 'components.yml#/components/responses/NoContent'
				103	'400':
				104	$ref: 'components.yml#/components/responses/BadRequest'
				105	'401':
				106	$ref: 'components.yml#/components/responses/Unauthorized'
				107	'403':
				108	$ref: 'components.yml#/components/responses/Forbidden'
				109	'409':
				110	$ref: 'components.yml#/components/responses/Conflict'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	111
				112	anchorsByDataspace:
				113	get:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	114	description: Read all anchors, given a dataspace
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	115	tags:
				116	- cps-admin
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	117	summary: Get anchors
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	118	operationId: getAnchors
				119	parameters:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	120	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	121	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	122	'200':
				123	$ref: 'components.yml#/components/responses/Ok'
				124	'400':
				125	$ref: 'components.yml#/components/responses/BadRequest'
				126	'401':
				127	$ref: 'components.yml#/components/responses/Unauthorized'
				128	'403':
				129	$ref: 'components.yml#/components/responses/Forbidden'
				130	'404':
				131	$ref: 'components.yml#/components/responses/NotFound'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	132
				133	post:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	134	description: Create a new anchor in the given dataspace
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	135	tags:
				136	- cps-admin
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	137	summary: Create an anchor
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	138	operationId: createAnchor
				139	parameters:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	140	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				141	- $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
				142	- $ref: 'components.yml#/components/parameters/anchorNameInQuery'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	143	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	144	'201':
				145	$ref: 'components.yml#/components/responses/Created'
				146	'400':
				147	$ref: 'components.yml#/components/responses/BadRequest'
				148	'401':
				149	$ref: 'components.yml#/components/responses/Unauthorized'
				150	'403':
				151	$ref: 'components.yml#/components/responses/Forbidden'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	152
				153	anchorByDataspaceAndAnchorName:
				154	get:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	155	description: Read an anchor given an anchor name and a dataspace
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	156	tags:
				157	- cps-admin
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	158	summary: Get an anchor
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	159	operationId: getAnchor
				160	parameters:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	161	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				162	- $ref: 'components.yml#/components/parameters/anchorNameInPath'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	163	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	164	'200':
				165	$ref: 'components.yml#/components/responses/Ok'
				166	'400':
				167	$ref: 'components.yml#/components/responses/BadRequest'
				168	'401':
				169	$ref: 'components.yml#/components/responses/Unauthorized'
				170	'403':
				171	$ref: 'components.yml#/components/responses/Forbidden'
				172	'404':
				173	$ref: 'components.yml#/components/responses/NotFound'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	174
				175	delete:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	176	description: Delete an anchor given an anchor name and a dataspace - DRAFT
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	177	tags:
				178	- cps-admin
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	179	summary: Delete an anchor
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	180	operationId: deleteAnchor
				181	parameters:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	182	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				183	- $ref: 'components.yml#/components/parameters/anchorNameInPath'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	184	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	185	'200':
				186	$ref: 'components.yml#/components/responses/Ok'
				187	'204':
				188	$ref: 'components.yml#/components/responses/NoContent'
				189	'400':
				190	$ref: 'components.yml#/components/responses/BadRequest'
				191	'401':
				192	$ref: 'components.yml#/components/responses/Unauthorized'
				193	'403':
				194	$ref: 'components.yml#/components/responses/Forbidden'