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

38 lines
963 B
Markdown
Raw Normal View History

apidocs: Replace hardcoded titles with generated ones. This commit replaces the hardcoded titles of /api pages with the auto-generated ones from the openapi data using the markdown processor.
2021-05-22 13:21:18 +02:00
{generate_api_title(/users/me/subscriptions:delete)}
api docs: Document the `DELETE /users/me/subscriptions` endpoint. Note that there is currently no JavaScript method in zulip-js to call this endpoint.
2018-01-11 01:43:08 +01: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(/users/me/subscriptions:delete)}
api docs: Document the `DELETE /users/me/subscriptions` endpoint. Note that there is currently no JavaScript method in zulip-js to call this endpoint.
2018-01-11 01:43:08 +01:00
## Usage examples
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{start_tabs}
{tab|python}
api docs: Document the `DELETE /users/me/subscriptions` endpoint. Note that there is currently no JavaScript method in zulip-js to call this endpoint.
2018-01-11 01:43:08 +01:00
api docs: Migrate DELETE /users/me/subscriptions to OpenAPI.
2018-06-21 02:23:47 +02:00
{generate_code_example(python)|/users/me/subscriptions:delete|example}
api docs: Document the `DELETE /users/me/subscriptions` endpoint. Note that there is currently no JavaScript method in zulip-js to call this endpoint.
2018-01-11 01:43:08 +01:00
js_examples: Migrate and test remove_subscriptions example.
2020-06-21 23:46:13 +02:00
{generate_code_example(javascript)|/users/me/subscriptions:delete|example}
api/remove-subscriptions: Add JavaScript example.
2018-01-13 23:20:46 +01:00
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{tab|curl}
docs: Make remove-subscriptions use curl example system.
2019-10-10 14:18:54 +02:00
{generate_code_example(curl, include=["subscriptions"])|/users/me/subscriptions:delete|example}
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +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
You may specify the `principals` parameter like so:
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
docs: Make remove-subscriptions use curl example system.
2019-10-10 14:18:54 +02:00
{generate_code_example(curl)|/users/me/subscriptions:delete|example}
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
**Note**: Unsubscribing another user from a stream requires
administrative privileges.
api docs: Document the `DELETE /users/me/subscriptions` endpoint. Note that there is currently no JavaScript method in zulip-js to call this endpoint.
2018-01-11 01:43:08 +01:00
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{end_tabs}
api docs: Document the `DELETE /users/me/subscriptions` endpoint. Note that there is currently no JavaScript method in zulip-js to call this endpoint.
2018-01-11 01:43:08 +01: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 docs: Move code examples farther up.
2018-01-20 22:03:05 +01:00
api docs: Migrate DELETE /users/me/subscriptions to OpenAPI.
2018-06-21 02:23:47 +02:00
{generate_api_arguments_table|zulip.yaml|/users/me/subscriptions:delete}
api docs: Move code examples farther up.
2018-01-20 22:03:05 +01:00
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|/users/me/subscriptions:delete}
api docs: Document the `DELETE /users/me/subscriptions` endpoint. Note that there is currently no JavaScript method in zulip-js to call this endpoint.
2018-01-11 01:43:08 +01:00
#### Example response
api docs: Migrate DELETE /users/me/subscriptions to OpenAPI.
2018-06-21 02:23:47 +02:00
{generate_code_example|/users/me/subscriptions:delete|fixture(200)}
api docs: Document the `DELETE /users/me/subscriptions` endpoint. Note that there is currently no JavaScript method in zulip-js to call this endpoint.
2018-01-11 01:43:08 +01:00
api docs: Migrate DELETE /users/me/subscriptions to OpenAPI.
2018-06-21 02:23:47 +02:00
{generate_code_example|/users/me/subscriptions:delete|fixture(400)}