mirror of
https://github.com/zulip/zulip.git
synced 2026-07-09 21:21:47 +08:00
1505f77ca3
Currently, the OpenAPI extension for rendering description in docs
cannot parse {!api-admin-only.md!}. Edit order of markdown extensions
in app_filters.py so that rendering of OpenAPI elements takes place
before substitution of files using `include`.
33 lines
593 B
Markdown
33 lines
593 B
Markdown
# Update a user
|
|
|
|
{generate_api_description(/users/{user_id}:patch)}
|
|
|
|
## Usage examples
|
|
|
|
{start_tabs}
|
|
{tab|python}
|
|
|
|
{generate_code_example(python)|/users/{user_id}:patch|example}
|
|
|
|
{tab|curl}
|
|
|
|
{generate_code_example(curl)|/users/{user_id}:patch|example}
|
|
|
|
{end_tabs}
|
|
|
|
## Parameters
|
|
|
|
{generate_api_arguments_table|zulip.yaml|/users/{user_id}:patch}
|
|
|
|
## Response
|
|
|
|
#### Example response
|
|
|
|
A typical successful JSON response may look like:
|
|
|
|
{generate_code_example|/users/{user_id}:patch|fixture(200)}
|
|
|
|
A typical unsuccessful JSON response:
|
|
|
|
{generate_code_example|/users/{user_id}:patch|fixture(400)}
|