diff options
| author |   DylanB95EST <dylan.byrne@est.tech> | 2021-11-02 17:25:18 +0000 |
|---|---|---|
| committer | DylanB95EST <dylan.byrne@est.tech> | 2021-11-02 17:25:23 +0000 |
| commit | 30a59dda3869603b9f628c45364e63a3763d3925 (patch) | |
| tree | 43943286fd3a32b2bd7ad32280bf3a61cbd5f24d /cps-rest/docs | |
| parent | 6fda688fa63ea7ccd450002fb94a18b07095bea9 (diff) | |
Delete DataNode (xpath) for a given Anchor
Delete Datanode within CPS. Deprecates delete functionality of
/v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes.
New api is backwards compatible with this API
Issue-ID: CPS-313
Change-Id: I110c4ab1446e8a1399a0d9bf89c0be614a9104df
Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
Diffstat (limited to 'cps-rest/docs')
| -rw-r--r-- | cps-rest/docs/openapi/cpsData.yml | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/cps-rest/docs/openapi/cpsData.yml b/cps-rest/docs/openapi/cpsData.yml index ca21df53db..2b65ae4400 100644 --- a/cps-rest/docs/openapi/cpsData.yml +++ b/cps-rest/docs/openapi/cpsData.yml @@ -103,6 +103,7 @@ listElementByDataspaceAndAnchor: delete: description: Delete one or all list element(s) for a given anchor and dataspace + deprecated: true tags: - cps-data summary: Delete one or all list element(s) @@ -177,6 +178,28 @@ nodesByDataspaceAndAnchor: '403': $ref: 'components.yml#/components/responses/Forbidden' + delete: + description: Delete a datanode for a given dataspace and anchor given a node xpath. + tags: + - cps-data + summary: Delete a data node + operationId: deleteDataNode + parameters: + - $ref: 'components.yml#/components/parameters/dataspaceNameInPath' + - $ref: 'components.yml#/components/parameters/anchorNameInPath' + - $ref: 'components.yml#/components/parameters/xpathInQuery' + - $ref: 'components.yml#/components/parameters/observedTimestampInQuery' + responses: + '204': + $ref: 'components.yml#/components/responses/NoContent' + '400': + $ref: 'components.yml#/components/responses/BadRequest' + '401': + $ref: 'components.yml#/components/responses/Unauthorized' + '403': + $ref: 'components.yml#/components/responses/Forbidden' + + put: description: Replace a node with descendants for a given dataspace, anchor and a parent node xpath tags: |