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

blob: aa8a31dfcb0da1530316a6176444609fc40fc911 [file] [log] [blame]

Rishi.Chail	dacc663	2021-01-27 04:27:34 +0000	[diff] [blame]	1	nodeByDataspaceAndAnchor:
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	2	get:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	3	description: Get a node with an option to retrieve all the children for a given anchor and dataspace
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	4	tags:
				5	- cps-data
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	6	summary: Get a node
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	7	operationId: getNodeByDataspaceAndAnchor
				8	parameters:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	9	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				10	- $ref: 'components.yml#/components/parameters/anchorNameInPath'
				11	- $ref: 'components.yml#/components/parameters/xpathInQuery'
				12	- $ref: 'components.yml#/components/parameters/includeDescendantsOptionInQuery'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	13	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	14	'200':
				15	$ref: 'components.yml#/components/responses/Ok'
				16	'400':
				17	$ref: 'components.yml#/components/responses/BadRequest'
				18	'401':
				19	$ref: 'components.yml#/components/responses/Unauthorized'
				20	'403':
				21	$ref: 'components.yml#/components/responses/Forbidden'
				22	'404':
				23	$ref: 'components.yml#/components/responses/NotFound'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	24	x-codegen-request-body-name: xpath
				25
Ruslan Kashapov	0905ac1	2021-05-05 13:11:50 +0300	[diff] [blame]	26	listNodeByDataspaceAndAnchor:
				27	post:
				28	description: Add list-node child elements to existing node for a given anchor and dataspace
				29	tags:
				30	- cps-data
				31	summary: Add list-node child element(s) under existing parent node
				32	operationId: addListNodeElements
				33	parameters:
				34	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				35	- $ref: 'components.yml#/components/parameters/anchorNameInPath'
				36	- $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
				37	requestBody:
				38	required: true
				39	content:
				40	application/json:
				41	schema:
				42	type: string
				43	responses:
				44	'201':
				45	$ref: 'components.yml#/components/responses/Created'
				46	'400':
				47	$ref: 'components.yml#/components/responses/BadRequest'
				48	'401':
				49	$ref: 'components.yml#/components/responses/Unauthorized'
				50	'403':
				51	$ref: 'components.yml#/components/responses/Forbidden'
				52
Ruslan Kashapov	576f48e	2021-05-14 14:41:05 +0300	[diff] [blame^]	53	patch:
				54	description: Replace list-node child elements under existing node for a given anchor and dataspace
				55	tags:
				56	- cps-data
				57	summary: Replace list-node child element(s) under existing parent node
				58	operationId: replaceListNodeElements
				59	parameters:
				60	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				61	- $ref: 'components.yml#/components/parameters/anchorNameInPath'
				62	- $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
				63	requestBody:
				64	required: true
				65	content:
				66	application/json:
				67	schema:
				68	type: string
				69	responses:
				70	'200':
				71	$ref: 'components.yml#/components/responses/Created'
				72	'400':
				73	$ref: 'components.yml#/components/responses/BadRequest'
				74	'401':
				75	$ref: 'components.yml#/components/responses/Unauthorized'
				76	'403':
				77	$ref: 'components.yml#/components/responses/Forbidden'
				78
Rishi.Chail	dacc663	2021-01-27 04:27:34 +0000	[diff] [blame]	79	nodesByDataspaceAndAnchor:
niamhcore	74753d9	2021-01-28 16:11:52 +0000	[diff] [blame]	80	post:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	81	description: Create a node for a given anchor and dataspace
niamhcore	74753d9	2021-01-28 16:11:52 +0000	[diff] [blame]	82	tags:
				83	- cps-data
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	84	summary: Create a node
niamhcore	74753d9	2021-01-28 16:11:52 +0000	[diff] [blame]	85	operationId: createNode
				86	parameters:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	87	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				88	- $ref: 'components.yml#/components/parameters/anchorNameInPath'
Ruslan Kashapov	24bf350	2021-04-19 12:40:01 +0300	[diff] [blame]	89	- $ref: 'components.yml#/components/parameters/xpathInQuery'
niamhcore	74753d9	2021-01-28 16:11:52 +0000	[diff] [blame]	90	requestBody:
				91	required: true
				92	content:
				93	application/json:
				94	schema:
				95	type: string
				96	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	97	'201':
				98	$ref: 'components.yml#/components/responses/Created'
				99	'400':
				100	$ref: 'components.yml#/components/responses/BadRequest'
				101	'401':
				102	$ref: 'components.yml#/components/responses/Unauthorized'
				103	'403':
				104	$ref: 'components.yml#/components/responses/Forbidden'
niamhcore	74753d9	2021-01-28 16:11:52 +0000	[diff] [blame]	105
Ruslan Kashapov	24c72db	2021-02-09 17:25:18 +0200	[diff] [blame]	106	patch:
				107	description: Update a data node leaves for a given dataspace and anchor and a parent node xpath
				108	tags:
				109	- cps-data
				110	summary: Update node leaves
				111	operationId: updateNodeLeaves
				112	parameters:
				113	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				114	- $ref: 'components.yml#/components/parameters/anchorNameInPath'
				115	- $ref: 'components.yml#/components/parameters/xpathInQuery'
				116	requestBody:
				117	required: true
				118	content:
				119	application/json:
				120	schema:
				121	type: string
				122	responses:
				123	'200':
				124	$ref: 'components.yml#/components/responses/Ok'
				125	'400':
				126	$ref: 'components.yml#/components/responses/BadRequest'
				127	'401':
				128	$ref: 'components.yml#/components/responses/Unauthorized'
				129	'403':
				130	$ref: 'components.yml#/components/responses/Forbidden'
				131
				132	put:
				133	description: Replace a node with descendants for a given dataspace, anchor and a parent node xpath
				134	tags:
				135	- cps-data
				136	summary: Replace a node with descendants
				137	operationId: replaceNode
				138	parameters:
				139	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
				140	- $ref: 'components.yml#/components/parameters/anchorNameInPath'
				141	- $ref: 'components.yml#/components/parameters/xpathInQuery'
				142	requestBody:
				143	required: true
				144	content:
				145	application/json:
				146	schema:
				147	type: string
				148	responses:
				149	'200':
				150	$ref: 'components.yml#/components/responses/Ok'
				151	'400':
				152	$ref: 'components.yml#/components/responses/BadRequest'
				153	'401':
				154	$ref: 'components.yml#/components/responses/Unauthorized'
				155	'403':
				156	$ref: 'components.yml#/components/responses/Forbidden'
				157
				158
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	159	nodesByDataspace:
				160	get:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	161	description: Get all nodes for a given dataspace using an xpath or schema node identifier - DRAFT
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	162	tags:
				163	- cps-data
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	164	summary: Get nodes
				165	operationId: getNodesByDataspace
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	166	parameters:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	167	- $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
puthuparambil.aditya	001e773	2021-01-13 12:06:20 +0000	[diff] [blame]	168	responses:
Rishi.Chail	6d13f16	2021-01-26 05:58:39 +0000	[diff] [blame]	169	'200':
				170	$ref: 'components.yml#/components/responses/Ok'
				171	'400':
				172	$ref: 'components.yml#/components/responses/BadRequest'
				173	'401':
				174	$ref: 'components.yml#/components/responses/Unauthorized'
				175	'403':
				176	$ref: 'components.yml#/components/responses/Forbidden'
				177	'404':
				178	$ref: 'components.yml#/components/responses/NotFound'
				179	x-codegen-request-body-name: requestBody