Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/templates/zerver/api/get-user-groups.md

35 lines
570 B
Markdown
Raw Normal View History

api: Add GET /user_groups documentation. This documents our GET endpoint for interacting with Zulip's user groups feature. Fixes #10298.
2018-08-18 23:06:53 +02:00
# Get user groups
api docs: Use Help Center syntax for restricted endpoints.
2019-07-30 01:17:54 +02:00
{!api-members-only.md!}
api: Add GET /user_groups documentation. This documents our GET endpoint for interacting with Zulip's user groups feature. Fixes #10298.
2018-08-18 23:06:53 +02:00
openapi: Use description markdown for rendering endpoint descriptions. Firstly, change endpoint descriptions in zulip.yaml so that they match their counterpart in the api docs. Then edit the api docs so that they use api description markdown extension for displaying endpoint description.
2020-04-28 20:00:46 +02:00
{generate_api_description(/user_groups:get)}
api: Add GET /user_groups documentation. This documents our GET endpoint for interacting with Zulip's user groups feature. Fixes #10298.
2018-08-18 23:06:53 +02:00
## Usage examples
api docs: Fix syntax for get-user-groups. This apparently had some sort of rebase conflict issue with the migration to the nicer syntax for tabs.
2019-06-25 07:22:00 +02:00
{start_tabs}
{tab|python}
api: Add GET /user_groups documentation. This documents our GET endpoint for interacting with Zulip's user groups feature. Fixes #10298.
2018-08-18 23:06:53 +02:00
api docs: Fix syntax for get-user-groups. This apparently had some sort of rebase conflict issue with the migration to the nicer syntax for tabs.
2019-06-25 07:22:00 +02:00
{generate_code_example(python)|/user_groups:get|example}
{tab|curl}
api: Add GET /user_groups documentation. This documents our GET endpoint for interacting with Zulip's user groups feature. Fixes #10298.
2018-08-18 23:06:53 +02:00
docs: Make get-user-groups use curl example system.
2019-10-14 08:13:40 +02:00
{generate_code_example(curl)|/user_groups:get|example}
api: Add GET /user_groups documentation. This documents our GET endpoint for interacting with Zulip's user groups feature. Fixes #10298.
2018-08-18 23:06:53 +02:00
api docs: Fix syntax for get-user-groups. This apparently had some sort of rebase conflict issue with the migration to the nicer syntax for tabs.
2019-06-25 07:22:00 +02:00
{end_tabs}
api: Add GET /user_groups documentation. This documents our GET endpoint for interacting with Zulip's user groups feature. Fixes #10298.
2018-08-18 23:06:53 +02:00
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 15:35:25 +02:00
## Parameters
api: Add GET /user_groups documentation. This documents our GET endpoint for interacting with Zulip's user groups feature. Fixes #10298.
2018-08-18 23:06:53 +02:00
{generate_api_arguments_table|zulip.yaml|/user_groups:get}
## Response
#### Return values
openapi: Add markdown extension for rendering return values in API docs. Currently response return values have to be written twice, once in the docs and once in zulip.yaml. Create a markdown extension so that the return values in api docs are rendered using content from zulip.yaml
2020-05-20 11:57:57 +02:00
{generate_return_values_table|zulip.yaml|/user_groups:get}
api: Add GET /user_groups documentation. This documents our GET endpoint for interacting with Zulip's user groups feature. Fixes #10298.
2018-08-18 23:06:53 +02:00
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/user_groups:get|fixture(200)}