diff options
| author | Vishakha Agarwal <agarwalvishakha18@gmail.com> | 2020-03-02 15:43:27 +0530 |
|---|---|---|
| committer | Vishakha Agarwal <agarwalvishakha18@gmail.com> | 2020-03-10 17:13:19 +0000 |
| commit | 271c09bb538b838e05865df034ba0f98f4a26259 (patch) | |
| tree | ae7fc8d8fdfd074671990c4037e0e994f9f219e8 /api-ref | |
| parent | 97d83016afb93dd6981ce8bb07d8019384d8df22 (diff) | |
| download | keystone-271c09bb538b838e05865df034ba0f98f4a26259.tar.gz | |
Correcting api-ref for users
The "options" is not "optional" in user api responses.
This patch removes the 'optional' from the same and also updates
string with the format to be used while creating api-ref in
keystone.
Change-Id: I848f168215800b42480d14f1f1905d8843ed3faa
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/v3/parameters.yaml | 19 | ||||
| -rw-r--r-- | api-ref/source/v3/users.inc | 4 |
2 files changed, 11 insertions, 12 deletions
diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml index 8ea55dabe..724ab3582 100644 --- a/api-ref/source/v3/parameters.yaml +++ b/api-ref/source/v3/parameters.yaml @@ -1848,6 +1848,15 @@ response_limit_domain_id_body: in: body required: true type: string +response_user_options_body_required: + description: | + The resource options for the user. Available resource options are + ``ignore_change_password_upon_first_use``, ``ignore_password_expiry``, + ``ignore_lockout_failure_attempts``, ``lock_password``, + ``multi_factor_auth_enabled``, and ``multi_factor_auth_rules``. + in: body + required: true + type: object role: description: | A ``role`` object @@ -2143,16 +2152,6 @@ user_options_request_body: in: body required: false type: object -user_options_response_body: - description: | - The resource options for the user. Only present in the response if set on - the user entity. Available resource options are - ``ignore_change_password_upon_first_use``, ``ignore_password_expiry``, - ``ignore_lockout_failure_attempts``, ``lock_password``, - ``multi_factor_auth_enabled``, and ``multi_factor_auth_rules``. - in: body - required: false - type: object user_password_update_body: description: | The new password for the user. diff --git a/api-ref/source/v3/users.inc b/api-ref/source/v3/users.inc index aee2d3386..e6e21defa 100644 --- a/api-ref/source/v3/users.inc +++ b/api-ref/source/v3/users.inc @@ -128,7 +128,7 @@ Parameters - links: links_user - name: user_name_response_body - password_expires_at: password_expires_at - - options: user_options_response_body + - options: response_user_options_body_required Status Codes ~~~~~~~~~~~~ @@ -259,7 +259,7 @@ Parameters - links: links_user - name: user_name_response_body - password_expires_at: password_expires_at - - options: user_options_response_body + - options: response_user_options_body_required Status Codes ~~~~~~~~~~~~ |