CodeCow/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2026-07-06 21:18:58 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
e797fa4ea1
zulip/templates/zerver/api/mute-topic.md
orientor d8ef853545 openapi: Make api-docs filename match with operationIds. 
api docs filenames are basically the operationId of their endpoint
in zulip.yaml with `_` replaced by `-`. But some operationIds have
changed, so change the affected filenames. Make changes in other
files accordingly.
2020-06-18 22:38:05 -07:00

1007 B
Raw Blame History

Topic muting

{generate_api_description(/users/me/subscriptions/muted_topics:patch)}

Usage examples

{start_tabs} {tab|python}

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

{tab|curl}

{generate_code_example(curl, exclude=["stream_id"])|/users/me/subscriptions/muted_topics:patch|example}

{end_tabs}

Parameters

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

Response

Example response

A typical successful JSON response may look like:

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

An example JSON response for when an add operation is requested for a topic that has already been muted:

{generate_code_example|/users/me/subscriptions/muted_topics:patch|fixture(400_0)}

An example JSON response for when a remove operation is requested for a topic that had not been previously muted:

{generate_code_example|/users/me/subscriptions/muted_topics:patch|fixture(400_1)}