mirror of
https://github.com/zulip/zulip.git
synced 2025-11-05 22:43:42 +00:00
api: Document DELETE ../users/{user_id} endpoint.
This adds deactivate_user to python_examples.py in zerver/openapi. This also adds delete-user.md to templates/zerver/api and adds delete-user to rest-endpoints.md (templates/zerver/help/include).
This commit is contained in:
@@ -242,6 +242,21 @@ def get_single_user(client):
|
||||
|
||||
validate_against_openapi_schema(result, '/users/{user_id}', 'get', '200')
|
||||
|
||||
@openapi_test_function("/users/{user_id}:delete")
|
||||
def deactivate_user(client):
|
||||
# type: (Client) -> None
|
||||
|
||||
# {code_example|start}
|
||||
# Deactivate a user
|
||||
user_id = 8
|
||||
url = 'users/' + str(user_id)
|
||||
result = client.call_endpoint(
|
||||
url=url,
|
||||
method='DELETE',
|
||||
)
|
||||
# {code_example|end}
|
||||
validate_against_openapi_schema(result, '/users/{user_id}', 'delete', '200')
|
||||
|
||||
@openapi_test_function("/realm/filters:get")
|
||||
def get_realm_filters(client):
|
||||
# type: (Client) -> None
|
||||
@@ -1150,6 +1165,7 @@ def test_users(client):
|
||||
create_user(client)
|
||||
get_members(client)
|
||||
get_single_user(client)
|
||||
deactivate_user(client)
|
||||
get_profile(client)
|
||||
update_notification_settings(client)
|
||||
upload_file(client)
|
||||
|
||||
Reference in New Issue
Block a user