From 832d4f97fdcacd63843adb9cb1d3f18e8c96cc1b Mon Sep 17 00:00:00 2001 From: Anders Kaseorg Date: Mon, 21 Aug 2023 14:52:16 -0700 Subject: [PATCH] api_docs: Split bulk mark read documentation to individual pages. There was no particular reason for this to be the single page that documented multiple API endpoints, and splitting it fixes a duplicate ID parameter-stream_id. Signed-off-by: Anders Kaseorg --- api_docs/include/rest-endpoints.md | 4 +- api_docs/mark-all-as-read.md | 89 ------------------------------ 2 files changed, 3 insertions(+), 90 deletions(-) delete mode 100644 api_docs/mark-all-as-read.md diff --git a/api_docs/include/rest-endpoints.md b/api_docs/include/rest-endpoints.md index 449e5658cd..c34a2d256b 100644 --- a/api_docs/include/rest-endpoints.md +++ b/api_docs/include/rest-endpoints.md @@ -14,7 +14,9 @@ * [Get a message's edit history](/api/get-message-history) * [Update personal message flags](/api/update-message-flags) * [Update personal message flags for narrow](/api/update-message-flags-for-narrow) -* [Mark messages as read in bulk](/api/mark-all-as-read) +* [Mark all messages as read](/api/mark-all-as-read) +* [Mark messages in a stream as read](/api/mark-stream-as-read) +* [Mark messages in a topic as read](/api/mark-topic-as-read) * [Get a message's read receipts](/api/get-read-receipts) #### Scheduled messages diff --git a/api_docs/mark-all-as-read.md b/api_docs/mark-all-as-read.md deleted file mode 100644 index d21849e117..0000000000 --- a/api_docs/mark-all-as-read.md +++ /dev/null @@ -1,89 +0,0 @@ -{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}