Documentation updated in docs/ncmp-inventory-querying.rst
- Existing API docs in docs/ncmp-cmhandle-querying.rst is updated where
CPS Path is now supported as ancestor axis.
Issue-ID: CPS-2289
Change-Id: I065179fe7c294588580448a8467765e9d116d33a
Signed-off-by: sourabh_sourabh <sourabh.sourabh@est.tech>
diff --git a/docs/ncmp-inventory-querying.rst b/docs/ncmp-inventory-querying.rst
index 349b984..084eaaf 100644
--- a/docs/ncmp-inventory-querying.rst
+++ b/docs/ncmp-inventory-querying.rst
@@ -156,3 +156,23 @@
}
]
}
+
+CM Handle search with CPS Path
+------------------------------
+
+The *cmHandleWithCpsPath* condition allows any data of the CM Handle to be queried as long as it is accessible by CPS path. CPS path is described in detail in :doc:`cps-path`. For this endpoint, the ancestor axis for CM Handles is appended automatically so that a CM Handle is always returned. For example ``/dmi-registry/cm-handles[@module-set-tag='']`` will become ``/dmi-registry/cm-handles[@module-set-tag='']/ancestor::cm-handles``.
+
+.. code-block:: json
+
+ {
+ "cmHandleQueryParameters": [
+ {
+ "conditionName": "cmHandleWithCpsPath",
+ "conditionParameters": [
+ {
+ "cpsPath": "/dmi-registry/cm-handles[@module-set-tag='some-value or empty']"
+ }
+ ]
+ }
+ ]
+ }
\ No newline at end of file