summaryrefslogtreecommitdiffstats
path: root/docs/cps-path.rst
diff options
context:
space:
mode:
authorputhuparambil.aditya <aditya.puthuparambil@bell.ca>2021-04-23 12:52:09 +0100
committerputhuparambil.aditya <aditya.puthuparambil@bell.ca>2021-04-23 12:56:44 +0100
commit05316071752c98620a4aa77fa13998a654546cd5 (patch)
tree1544ec2276b6faecdec9715d71e2990153b4f2ea /docs/cps-path.rst
parentff71462728d8eb63d36ad4c3ede24f10ea030c14 (diff)
Documents update for multiple attributes support in Get Descendent API
Issue-ID: CPS-309 Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca> Change-Id: Iceb62b784e3e5281d8a8ab443c4ece45fa121dc2
Diffstat (limited to 'docs/cps-path.rst')
-rw-r--r--docs/cps-path.rst11
1 files changed, 5 insertions, 6 deletions
diff --git a/docs/cps-path.rst b/docs/cps-path.rst
index 91bfdcb431..160aa9389c 100644
--- a/docs/cps-path.rst
+++ b/docs/cps-path.rst
@@ -74,7 +74,7 @@ Get List Elements by Any Attribute Value
- Only string and integer values are supported (boolean and float values are not supported).
**Notes**
- - For performance reasons it does not make sense to query the list key leaf. If the key value is known it is better to execute a get request with the complete xpath.
+ - For performance reasons it does not make sense to query using key leaf as attribute. If the key value is known it is better to execute a get request with the complete xpath.
Get Any Descendant
------------------
@@ -93,13 +93,13 @@ Get Any Descendant
- List elements can only be addressed using the list key leaf.
Get Any Descendant by Any Attribute Value
-------------------------------------------
+-----------------------------------------
**Syntax**: ``//<direct-ancestors><target-node>[@<leaf-name>=<leaf-value>]``
- ``direct-ancestors``: Optional path to direct ancestors of the target node. This can contain zero to many ancestor nodes separated by a /.
- ``target-node``: The name of the (list) node which elements will queried.
- - ``leaf-name``: The name of the leaf which value needs to be compared.
- - ``leaf-value``: The required value of the leaf.
+ - ``leaf1-name .. leafN-name:``: One or more leaves whose value needs to be compared.
+ - ``leaf1-value .. leafN-value:``: One or more required leaf values (multiple condition can be combined using the 'and' keyword).
**Examples**
- ``//categories[@name='Kids']``
@@ -107,5 +107,4 @@ Get Any Descendant by Any Attribute Value
**Limitations**
- Only string and integer values are supported (boolean and float values are not supported).
- - Multiple attributes should be separated by 'and'.
- - Trailing 'and' is ignored in the yang list. \ No newline at end of file
+ - Multiple attributes can only be combined using 'and'. 'or' and bracketing is not supported. \ No newline at end of file