From: Luke Gleeson <luke.gleeson@est.tech>
Date: Fri, 3 Feb 2023 10:08:57 +0000 (+0000)
Subject: Merge "Descendants description changed in openApi"
X-Git-Tag: 3.2.2~2
X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=f965c8eefcf21ceaeff1be461bc51269e1d36715;hp=a0aa860665b94ce35ecd6253e69959b7cf08ddb7;p=cps.git

Merge "Descendants description changed in openApi"
---

diff --git a/cps-rest/docs/openapi/components.yml b/cps-rest/docs/openapi/components.yml
index 60b4ca3189..2a8ba3adb3 100644
--- 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 53c72f559f..53bc840ec7 100644
--- 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":