summaryrefslogtreecommitdiffstats
path: root/docs/ncmp-cmhandle-querying.rst
diff options
context:
space:
mode:
authoremaclee <lee.anjella.macabuhay@est.tech>2022-08-31 15:53:10 +0100
committerToine Siebelink <toine.siebelink@est.tech>2022-09-01 06:42:30 +0000
commitb176de24a873cbd6ff8df07c7947ed6ba7093af7 (patch)
treea9da8f58744154b271b7945f9c55b7d7ef9157dd /docs/ncmp-cmhandle-querying.rst
parent0a86b485cce8ad91b5a83895449e0a2ac7ffe267 (diff)
Fixing RTD warnings
Issue-ID: CPS-1237 Signed-off-by: emaclee <lee.anjella.macabuhay@est.tech> Change-Id: I0f09d6355d23451207d2d937fbda155b1407fb5a
Diffstat (limited to 'docs/ncmp-cmhandle-querying.rst')
-rw-r--r--docs/ncmp-cmhandle-querying.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/ncmp-cmhandle-querying.rst b/docs/ncmp-cmhandle-querying.rst
index 0145c11b1..9b54aafae 100644
--- a/docs/ncmp-cmhandle-querying.rst
+++ b/docs/ncmp-cmhandle-querying.rst
@@ -37,7 +37,8 @@ Currently this endpoint allows three criteria to be query on:
Not all request body combinations have been validated and as such request bodies which do not conform to the structure as documented here can produce results in which all CM Handles are returned.
Casing conventions: 'camelCasing' and 'kebab-casing'
---------------------------------------------------
+----------------------------------------------------
+
.. note::
By convention REST JSON return bodies use 'camelCasing'. By convention field names in yang modelled data use 'kebab-casing'. Therefore some inconsistencies can be seen in the JSON use in CPS REST interfaces. For CM Handle related endpoints we return data in 'camelCasing'. But for *cmHandleWithCpsPath*, the query is accessing yang modelled field names and as such needs to use 'kebab-casing'. Therefore the dmi-registry field names should be referenced when using the *cmHandleWithCpsPath* condition: :doc:`modeling`
@@ -157,4 +158,4 @@ The *cmHandleWithCpsPath* condition allows any data of the CM Handle to be queri
]
}
]
- } \ No newline at end of file
+ }