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

blob: 1a2e65f7d4190dfcbb0ac07d33adffad5dea6920 [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':
JosephKeenan	c6865f3	2021-06-08 13:16:37 +0100	[diff] [blame]	81	description: OK
				82	content:
				83	application/json:
				84	schema:
				85	$ref: 'components.yml#/components/schemas/SchemaSetDetails'
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	86	'400':
				87	$ref: 'components.yml#/components/responses/BadRequest'
				88	'401':
				89	$ref: 'components.yml#/components/responses/Unauthorized'
				90	'403':
				91	$ref: 'components.yml#/components/responses/Forbidden'
				92	'404':
				93	$ref: 'components.yml#/components/responses/NotFound'
				94
Ruslan Kashapov	dce4e31	2021-01-11 15:34:10 +0200	[diff] [blame]	95	delete:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	96	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]	97	tags:
				98	- cps-admin
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	99	summary: Delete a schema set
Ruslan Kashapov	dce4e31	2021-01-11 15:34:10 +0200	[diff] [blame]	100	operationId: deleteSchemaSet
				101	parameters:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	102	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				103	- $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
Ruslan Kashapov	dce4e31	2021-01-11 15:34:10 +0200	[diff] [blame]	104	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	105	'204':
				106	$ref: 'components.yml#/components/responses/NoContent'
				107	'400':
				108	$ref: 'components.yml#/components/responses/BadRequest'
				109	'401':
				110	$ref: 'components.yml#/components/responses/Unauthorized'
				111	'403':
				112	$ref: 'components.yml#/components/responses/Forbidden'
				113	'409':
				114	$ref: 'components.yml#/components/responses/Conflict'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	115
				116	anchorsByDataspace:
				117	get:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	118	description: Read all anchors, given a dataspace
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	119	tags:
				120	- cps-admin
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	121	summary: Get anchors
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	122	operationId: getAnchors
				123	parameters:
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'
				136	'401':
				137	$ref: 'components.yml#/components/responses/Unauthorized'
				138	'403':
				139	$ref: 'components.yml#/components/responses/Forbidden'
				140	'404':
				141	$ref: 'components.yml#/components/responses/NotFound'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	142
				143	post:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	144	description: Create a new anchor in the given dataspace
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	145	tags:
				146	- cps-admin
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	147	summary: Create an anchor
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	148	operationId: createAnchor
				149	parameters:
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/schemaSetNameInQuery'
				152	- $ref: 'components.yml#/components/parameters/anchorNameInQuery'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	153	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	154	'201':
				155	$ref: 'components.yml#/components/responses/Created'
				156	'400':
				157	$ref: 'components.yml#/components/responses/BadRequest'
				158	'401':
				159	$ref: 'components.yml#/components/responses/Unauthorized'
				160	'403':
				161	$ref: 'components.yml#/components/responses/Forbidden'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	162
				163	anchorByDataspaceAndAnchorName:
				164	get:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	165	description: Read an anchor given an anchor name and a dataspace
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	166	tags:
				167	- cps-admin
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	168	summary: Get an anchor
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	169	operationId: getAnchor
				170	parameters:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	171	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				172	- $ref: 'components.yml#/components/parameters/anchorNameInPath'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	173	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	174	'200':
JosephKeenan	c6865f3	2021-06-08 13:16:37 +0100	[diff] [blame]	175	description: OK
				176	content:
				177	application/json:
				178	schema:
				179	$ref: 'components.yml#/components/schemas/AnchorDetails'
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	180	'400':
				181	$ref: 'components.yml#/components/responses/BadRequest'
				182	'401':
				183	$ref: 'components.yml#/components/responses/Unauthorized'
				184	'403':
				185	$ref: 'components.yml#/components/responses/Forbidden'
				186	'404':
				187	$ref: 'components.yml#/components/responses/NotFound'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	188
				189	delete:
Ruslan Kashapov	b20858b	2021-04-05 14:46:03 +0300	[diff] [blame]	190	description: Delete an anchor given an anchor name and a dataspace
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	191	tags:
				192	- cps-admin
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	193	summary: Delete an anchor
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	194	operationId: deleteAnchor
				195	parameters:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	196	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				197	- $ref: 'components.yml#/components/parameters/anchorNameInPath'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	198	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	199	'204':
				200	$ref: 'components.yml#/components/responses/NoContent'
				201	'400':
				202	$ref: 'components.yml#/components/responses/BadRequest'
				203	'401':
				204	$ref: 'components.yml#/components/responses/Unauthorized'
				205	'403':
JosephKeenan	c6865f3	2021-06-08 13:16:37 +0100	[diff] [blame]	206	$ref: 'components.yml#/components/responses/Forbidden'