mirror of https://github.com/zulip/zulip.git synced 2026-06-21 21:32:29 +08:00

orientor 817ee5c6b2 openapi_docs: Replace argument with parameter.

The term `parameter` is a better word than `argument` for data passed
to an API endpoint; this is why OpenAPI uses in their terminology.
Replace `argument` with `parameter` in the API docs to improve their
readability.

Fixes #15435.

2020-06-18 09:18:27 -07:00

804 B

Raw Blame History

Get a user

{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

A typical successful JSON response may look like:

{generate_code_example|/users/{user_id}:get|fixture(200)}

804 B Raw Blame History