mirror of https://github.com/zulip/zulip.git synced 2025-11-04 05:53:43 +00:00

Files

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

570 B

Raw Blame History

Get user groups

{!api-members-only.md!}

{generate_api_description(/user_groups:get)}

Usage examples

{start_tabs} {tab|python}

{generate_code_example(python)|/user_groups:get|example}

{tab|curl}

{generate_code_example(curl)|/user_groups:get|example}

{end_tabs}

Parameters

{generate_api_arguments_table|zulip.yaml|/user_groups:get}

Response

Return values

{generate_return_values_table|zulip.yaml|/user_groups:get}

Example response

A typical successful JSON response may look like:

{generate_code_example|/user_groups:get|fixture(200)}

570 B Raw Blame History