diff options
author | sourabh_sourabh <sourabh.sourabh@est.tech> | 2024-07-11 10:45:45 +0100 |
---|---|---|
committer | sourabh_sourabh <sourabh.sourabh@est.tech> | 2024-07-11 12:18:18 +0100 |
commit | 018743bc61b650571216bff97558d882e0623772 (patch) | |
tree | d001d3c897e05ab1c206e9049117dfe8519e1bf0 | |
parent | 93b52651f0fce4a2d60cd0aa6538e4155115e649 (diff) |
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>
-rw-r--r-- | docs/ncmp-inventory-querying.rst | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/ncmp-inventory-querying.rst b/docs/ncmp-inventory-querying.rst index 349b984963..084eaaf696 100644 --- a/docs/ncmp-inventory-querying.rst +++ b/docs/ncmp-inventory-querying.rst @@ -156,3 +156,23 @@ With the *cmHandleWithDmiPlugin* condition, we can provide a dmiPluginName. The } ] } + +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 |