diff options
Diffstat (limited to 'docs/cps-delta-endpoints.rst')
| -rw-r--r-- | docs/cps-delta-endpoints.rst | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/docs/cps-delta-endpoints.rst b/docs/cps-delta-endpoints.rst new file mode 100644 index 0000000000..b2e4e6041b --- /dev/null +++ b/docs/cps-delta-endpoints.rst @@ -0,0 +1,66 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2021 Pantheon.tech +.. Copyright (C) 2024 TechMahindra Ltd. +.. _cpsDeltaEndpoints: + +.. toctree:: + :maxdepth: 1 + +CPS Delta Endpoints +################### + +The CPS Delta feature provides 1 endpoint: + +- /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/delta + +Description +----------- +The following is a Get endpoint, which allows the user to find the delta between configurations stored under two anchors within the same dataspace. + +Path Parameters +--------------- +The endpoint takes 2 path parameters as input: + - **dataspace-name:** name of dataspace where the 2 anchors to be used for delta generation are stored. + - **anchor-name:** the source anchor name, the data under this anchor will be the reference data for delta report generation + +Query Parameters +---------------- +The endpoint takes 3 query parameters as input: + - **target-anchor-name:** the data retrieved from target anchor gets compared against the data retrieved from source anchor + - **xpath:** the xpath to a particular data node, Example: /bookstore/categories[@code='1'] + - **descendants:** specifies the number of descendants to query. + +Sample Delta Report +------------------- + +.. code-block:: json + + [ + { + "action": "ADD", + "xpath": "/bookstore/categories/[@code=3]", + "target-data": { + "code": "3,", + "name": "kidz" + } + }, + { + "action": "REMOVE", + "xpath": "/bookstore/categories/[@code=1]", + "source-data": { + "code": "1,", + "name": "Fiction" + } + }, + { + "action": "UPDATE", + "xpath": "/bookstore/categories/[@code=2]", + "source-data": { + "name": "Funny" + }, + "target-data": { + "name": "Comic" + } + } + ]
\ No newline at end of file |