Files
zulip/api_docs/mark-all-as-read.md
Lauryn Menard dbacc00f0f api-docs: Move markdown files to top level directory.
- Updates `.prettierignore` for the new directory.
- Updates any reference to the API documentation directory for
  markdown files to be `api_docs/` instead of `zerver/api/`.
- Removes a reference link from `docs/documentation/api.md` that
  hasn't referenced anything in the text since commit 0542c60.
- Update rendering of API documentation for new directory.
2023-02-02 17:25:40 -08:00

1.7 KiB

{generate_api_header(/mark_all_as_read:post)}

Usage examples

{start_tabs}

{generate_code_example(python)|/mark_all_as_read:post|example}

{generate_code_example(javascript)|/mark_all_as_read:post|example}

{tab|curl}

{generate_code_example(curl)|/mark_all_as_read:post|example}

{end_tabs}

Parameters

{generate_api_arguments_table|zulip.yaml|/mark_all_as_read:post}

{generate_parameter_description(/mark_all_as_read:post)}

Response

{generate_response_description(/mark_all_as_read:post)}

Example response(s)

{generate_code_example|/mark_all_as_read:post|fixture}

{generate_api_header(/mark_stream_as_read:post)}

Usage examples

{start_tabs}

{generate_code_example(python)|/mark_stream_as_read:post|example}

{generate_code_example(javascript)|/mark_all_as_read:post|example}

{tab|curl}

{generate_code_example(curl)|/mark_stream_as_read:post|example}

{end_tabs}

Parameters

{generate_api_arguments_table|zulip.yaml|/mark_stream_as_read:post}

{generate_parameter_description(/mark_all_as_read:post)}

Response

{generate_response_description(/mark_all_as_read:post)}

Example response(s)

{generate_code_example|/mark_stream_as_read:post|fixture}

{generate_api_header(/mark_topic_as_read:post)}

Usage examples

{start_tabs}

{generate_code_example(python)|/mark_topic_as_read:post|example}

{generate_code_example(javascript)|/mark_all_as_read:post|example}

{tab|curl}

{generate_code_example(curl)|/mark_topic_as_read:post|example}

{end_tabs}

Parameters

{generate_api_arguments_table|zulip.yaml|/mark_topic_as_read:post}

{generate_parameter_description(/mark_all_as_read:post)}

Response

{generate_response_description(/mark_all_as_read:post)}

Example response(s)

{generate_code_example|/mark_topic_as_read:post|fixture}