mirror of
https://github.com/zulip/zulip.git
synced 2026-06-24 21:08:25 +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`.
786 B
786 B
Create a user
{generate_api_description(/users:post)}
Usage examples
{start_tabs} {tab|python}
{generate_code_example(python)|/users:post|example(admin_config=True)}
{tab|js}
More examples and documentation can be found here.
{generate_code_example(javascript)|/users:post|example(admin_config=True)}
{tab|curl}
{generate_code_example(curl)|/users:post|example}
{end_tabs}
Parameters
{generate_api_arguments_table|zulip.yaml|/users:post}
Response
Example response
A typical successful JSON response may look like:
{generate_code_example|/users:post|fixture(200)}
A typical JSON response for when another user with the same email address already exists in the realm:
{generate_code_example|/users:post|fixture(400)}