mirror of
https://github.com/zulip/zulip.git
synced 2026-07-09 21:21:47 +08:00
817ee5c6b2
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.
35 lines
570 B
Markdown
35 lines
570 B
Markdown
# 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)}
|