Merge "Descendants description changed in openApi"

diff --git a/cps-rest/docs/openapi/components.yml b/cps-rest/docs/openapi/components.yml
index 60b4ca3..2a8ba3a 100644 (file)
--- a/cps-rest/docs/openapi/components.yml
+++ b/cps-rest/docs/openapi/components.yml
@@ -243,7 +243,7 @@ components:
     descendantsInQuery:
       name: descendants
       in: query
-      description: descendents to query depth of children. allowed values are none, all, any number starting from -1
+      description: Number of descendants to query. Allowed values are 'none', 'all', -1 (for all), 0 (for none) and any positive number.
       required: false
       schema:
         type: string

diff --git a/docs/api/swagger/cps/openapi.yaml b/docs/api/swagger/cps/openapi.yaml
index 53c72f5..53bc840 100644 (file)
--- a/docs/api/swagger/cps/openapi.yaml
+++ b/docs/api/swagger/cps/openapi.yaml
@@ -1320,12 +1320,11 @@ paths:
               value: "/shops/bookstore/categories[@code=1]"
         - name: descendants
           in: query
-          description: "descendents to query depth of children. allowed values are none,\
-          \ all, any number starting from -1"
+          description: "Number of descendants to query. Allowed values are 'none', 'all', -1 (for all), 0 (for none) and any positive number."
           required: false
           schema:
             type: string
-            example: "3"
+            example: 3
             default: none
       responses:
         "200":