CodeCow/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2026-07-09 21:21:47 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
1fa82c2fcd
zulip/templates/zerver/api/get-subscriptions.md
Suyash Vardhan Mathur 1fa82c2fcd apidocs: Fix response in API templates. 
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
2021-06-09 12:43:12 -07:00

979 B
Raw Blame History

{generate_api_title(/users/me/subscriptions:get)}

{generate_api_description(/users/me/subscriptions:get)}

Usage examples

{start_tabs} {tab|python}

{generate_code_example(python)|/users/me/subscriptions:get|example}

{tab|js}

More examples and documentation can be found here.

{generate_code_example(javascript)|/users/me/subscriptions:get|example}

{tab|curl}

{generate_code_example(curl, include=[""])|/users/me/subscriptions:get|example}

You may pass the include_subscribers query parameter as follows:

{generate_code_example(curl)|/users/me/subscriptions:get|example}

{end_tabs}

Parameters

{generate_api_arguments_table|zulip.yaml|/users/me/subscriptions:get}

Response

Return values

{generate_return_values_table|zulip.yaml|/users/me/subscriptions:get}

Example response

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

{generate_code_example|/users/me/subscriptions:get|fixture(400)}