Updated release notes with limitation related to cps path 45/131045/3
authorputhuparambil.aditya <aditya.puthuparambil@bell.ca>
Wed, 21 Sep 2022 09:53:51 +0000 (10:53 +0100)
committerputhuparambil.aditya <aditya.puthuparambil@bell.ca>
Thu, 22 Sep 2022 09:33:17 +0000 (10:33 +0100)
Issue-ID: CPS-1179
Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca>
Change-Id: I9fa7799e5a54b82b280606a14d09ce2256b844f2

docs/cps-path.rst
docs/release-notes.rst

index 44662d8..f321adf 100644 (file)
@@ -241,6 +241,7 @@ leaf-conditions
   - The key should be supplied with correct data type for it to be queried from DB. In the last example above the attribute code is of type
     Integer so the cps query will not work if the value is passed as string.
     eg: ``//categories[@code="1"]`` or ``//categories[@code='1']`` will not work because the key attribute code is treated a string.
+  - Having '[' token in any index in any list will have a negative impact on this function.
 
 **Notes**
   - 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.
@@ -265,6 +266,7 @@ The text()-condition  can be added to any CPS path query.
   - Only string and integer values are supported, boolean and float values are not supported.
   - Since CPS cannot return individual leaves it will always return the container with all its leaves. Ancestor-axis can be used to specify a parent higher up the tree.
   - When querying a leaf value (instead of leaf-list) it is better, more performant to use a text value condition use @<leaf-name> as described above.
+  - Having '[' token in any index in any list will have a negative impact on this function.
 
 ancestor-axis
 -------------
index d4f9843..46ffbb3 100755 (executable)
@@ -44,6 +44,15 @@ Features
 
 Bug Fixes
 ---------
+   - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
+
+Known Limitations, Issues and Workarounds
+-----------------------------------------
+
+*System Limitations*
+
+Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
+Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
 
 ..      ========================
 ..      * * *   JAKARTA   * * *