diff options
| author |   Luke Gleeson <luke.gleeson@est.tech> | 2023-02-03 10:08:57 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@onap.org> | 2023-02-03 10:08:57 +0000 |
| commit | f965c8eefcf21ceaeff1be461bc51269e1d36715 (patch) | |
| tree | 43b73d6429a8eb4c2bde2e07107f89b201d73bb1 | |
| parent | a0aa860665b94ce35ecd6253e69959b7cf08ddb7 (diff) | |
| parent | 5d881c3c71ad157824684e8ed443764c690692f8 (diff) | |
Merge "Descendants description changed in openApi"
| -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": |