diff options
| author |   rajesh.kumar <rk00747546@techmahindra.com> | 2023-02-03 06:36:40 +0000 |
|---|---|---|
| committer | rajesh.kumar <rk00747546@techmahindra.com> | 2023-02-03 06:36:40 +0000 |
| commit | 5d881c3c71ad157824684e8ed443764c690692f8 (patch) | |
| tree | b2c6bd36af3eb13b24f8af893865744efad5ba33 | |
| parent | 447c872eb3c9bd57631127651bc9744c5c1a8643 (diff) | |
Descendants description changed in openApi
Issue-ID: CPS-1381
Change-ID: I73f97f986a817d423f93a8d922dcd9647b0203aa
Signed-off-by: rajesh.kumar <rk00747546@techmahindra.com>
| -rw-r--r-- | cps-rest/docs/openapi/components.yml | 2 | ||||
| -rw-r--r-- | docs/api/swagger/cps/openapi.yaml | 5 |
2 files changed, 3 insertions, 4 deletions
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": |