mirror of
https://github.com/zulip/zulip.git
synced 2026-07-09 21:21:47 +08:00
1fa82c2fcd
Now, the descriptions and all subschemas are directly returned just by `generate_code_example`, and so, these individual subschemas and descriptions can be removed from the templates. All API endpoints docs are exactly the same after the change, except few where missing 400 responses got added due to the modification
842 B
842 B
{generate_api_title(/users/{user_id}:get)}
{generate_api_description(/users/{user_id}:get)}
Usage examples
{start_tabs} {tab|python}
{generate_code_example(python)|/users/{user_id}:get|example}
{tab|curl}
{generate_code_example(curl, include=[""])|/users/{user_id}:get|example}
You may pass the client_gravatar or include_custom_profile_fields query parameter as follows:
{generate_code_example(curl)|/users/{user_id}:get|example}
{end_tabs}
Parameters
Note: The following parameters are all URL query parameters.
{generate_api_arguments_table|zulip.yaml|/users/{user_id}:get}
Response
Return values
{generate_return_values_table|zulip.yaml}|/users/{user_id}:get}
Example response
{generate_code_example|/users/{user_id}:get|fixture(200)}
{generate_code_example|/users/{user_id}:get|fixture(400)}