...
Sample endpoints after change
After the update only the names of the endpoint will be updated, the path and query parameters will remain as it is. So, the updated APIs would be as follows:
| # | Sub interface | Existing Endpoint | Updated Endpoint | Path/Query Parameters | Response Codes |
|---|
| 1 | Data | GET-/v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/deltaAnchors | GET-/v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/delta |
| Parameter Name | In | Required | Description |
|---|
| dataspace-name | Path | Yes | Dataspace name | | anchor-name | Path | Yes | First Anchor Name/Reference Anchor | | descendants | Query | No | Level of descendants for delta comparison. | | target-anchor-name | Query | Yes | Second Anchor Name/Comparand Anchor | | xpath | Query | Yes | xpath of the node |
| - 200 (OK)
- 400
- dataspace not found
DataspaceNotFoundException - anchor not found
AnchorNotFoundException - Data node not found
DataNodeNotFoundException - invalid xpath
CpsPathException
- 500
|
| 2 | Data | POST- /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/deltaPayload | POST- /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/delta |
| Parameter Name | In | Required | Description |
|---|
| dataspace-name | Path | Yes | Dataspace name | | anchor-name | Path | Yes | First Anchor Name/Reference Anchor | | xpath | Query | Yes | xpath of the node | | File | Body of content type: multipart/form-data | Optional | Yang file/Zip file containing the schema details. | | Text/String | Body of content type: multipart/form-data | Yes | JSON payload as plain text |
|
