summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorhalil.cakal <halil.cakal@est.tech>2023-11-30 11:22:20 +0000
committerhalil.cakal <halil.cakal@est.tech>2023-12-04 10:08:40 +0000
commit230afc1143595e4e104ea16e5cda8d73a05d7b95 (patch)
tree7dbe20a7e505af5855069263db95a88a72689d9f /docs
parentc5e6ada7b5f90f7ab0316257f5ee59b257108de9 (diff)
Add documentation for the epic: Trust Level
- Request body enriched with the new condition name - Trust level section added and explained Issue-ID: CPS-1982 Change-Id: Iddeeae4101169fff0e5de8865f9a627e152ab472 Signed-off-by: halil.cakal <halil.cakal@est.tech>
Diffstat (limited to 'docs')
-rw-r--r--docs/ncmp-cmhandle-querying.rst30
1 files changed, 29 insertions, 1 deletions
diff --git a/docs/ncmp-cmhandle-querying.rst b/docs/ncmp-cmhandle-querying.rst
index 9b54aafae..529297daa 100644
--- a/docs/ncmp-cmhandle-querying.rst
+++ b/docs/ncmp-cmhandle-querying.rst
@@ -1,6 +1,6 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. Copyright (C) 2022 Nordix Foundation
+.. Copyright (C) 2022-2023 Nordix Foundation
.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
.. _cmhandlequerying:
@@ -83,6 +83,14 @@ Request Body example using all available query criteria. This query would return
"cpsPath": "//state[@cm-handle-state='ADVISED']"
}
]
+ },
+ {
+ "conditionName": "cmHandleWithTrustLevel",
+ "conditionParameters": [
+ {
+ "trustLevel": "COMPLETE"
+ }
+ ]
}
]
}
@@ -159,3 +167,23 @@ The *cmHandleWithCpsPath* condition allows any data of the CM Handle to be queri
}
]
}
+
+CM Handle with Trust Level
+--------------------------
+
+With the *cmHandleWithTrustLevel* condition, we can provide just one trust level. The CM handles returned will have this trust level. Providing more than one parameter causes unexpected results. Condition parameter name is not being validated.
+
+.. code-block:: json
+
+ {
+ "cmHandleQueryParameters": [
+ {
+ "conditionName": "cmHandleWithTrustLevel",
+ "conditionParameters": [
+ {
+ "trustLevel": "COMPLETE"
+ }
+ ]
+ }
+ ]
+ } \ No newline at end of file