diff options
| author |   Arpit Singh <as00745003@techmahindra.com> | 2024-09-04 11:02:06 +0530 |
|---|---|---|
| committer | Arpit Singh <as00745003@techmahindra.com> | 2024-09-10 10:10:29 +0000 |
| commit | 3c8539cf17b1698cadf08e6f3acc4a8b9273af85 (patch) | |
| tree | 491c24c147e6a303fcb68bbdf5b27bb6ae69ffd8 /docs/cps-delta-feature.rst | |
| parent | 3a4dcb5af00b85ae3f48709dfa0f9d797e02aabd (diff) | |
Renaming Delta Operations as per RFC 9144
RFC 9144 recommends naming convention for operations that can be performed on any datastore.
The recommended names are:
- create
- remove
- replace
Whereas in CPS Delta feature these operaitions were named:
- add
- remove
- update
So, "add" and "update" operations have been changed to "create" and "replace" respectively.
Issue-ID: CPS-2393
Change-Id: Ie39f5f8ccc91e96cf484ca7fbc833a6be8758054
Signed-off-by: Arpit Singh <as00745003@techmahindra.com>
Diffstat (limited to 'docs/cps-delta-feature.rst')
| -rw-r--r-- | docs/cps-delta-feature.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/cps-delta-feature.rst b/docs/cps-delta-feature.rst index f3a2f947e4..34aa43df53 100644 --- a/docs/cps-delta-feature.rst +++ b/docs/cps-delta-feature.rst @@ -22,10 +22,10 @@ Delta Report Format ------------------- The Delta Report is based on the RFC 9144, which defines a set of parameters to be included in the Delta Report. In CPS only the relevant parameters defined in RFC 9144 are used. These include: - - **action:** This parameter defines how the data nodes changed between two configurations. If data nodes are added, deleted or modified then the 'action' parameter in the delta report will be set to ADD, DELETE or UPDATE respectively for each data node. + - **action:** This parameter defines how the data nodes changed between two configurations. If data nodes are added, deleted or modified then the 'action' parameter in the delta report will be set to 'create', 'remove' or 'replace' respectively for each data node. - **xpath:** This parameter will provide the xpath of each data node that has been either added, deleted or modified. - - **source-data:** this parameter is added to the delta report when a data node is deleted or updated, this represents the source/reference data against which the delta is being generated. In case of newly added data node this field is not included in the delta report. - - **target-data:** this parameter is added to the delta report when a data node is added or updated, this represents the data values that are being compared to the source data. In case of a data node being deleted this field is not included in the delta report. + - **source-data:** this parameter is added to the delta report when a data node is removed or updated, this represents the source/reference data against which the delta is being generated. In case of newly added data node this field is not included in the delta report. + - **target-data:** this parameter is added to the delta report when a data node is added or updated, this represents the data values that are being compared to the source data. In case of a data node being removed this field is not included in the delta report. **Note.** In case of an existing data node being modified, both the source-data and target-data fields are present in the delta report. |