diff --git a/templates/zerver/api/add-linkifier.md b/templates/zerver/api/add-linkifier.md index 019b9027c0..934a136acb 100644 --- a/templates/zerver/api/add-linkifier.md +++ b/templates/zerver/api/add-linkifier.md @@ -1,4 +1,4 @@ -# Create linkifiers +# Add a linkifier {generate_api_description(/realm/filters:post)} diff --git a/templates/zerver/api/create-user-group.md b/templates/zerver/api/create-user-group.md index 2ff88211cb..944d961428 100644 --- a/templates/zerver/api/create-user-group.md +++ b/templates/zerver/api/create-user-group.md @@ -1,4 +1,4 @@ -# Create User Group +# Create a user group {generate_api_description(/user_groups/create:post)} diff --git a/templates/zerver/api/delete-queue.md b/templates/zerver/api/delete-queue.md index bf5e6dbb0c..e05ba3dd0c 100644 --- a/templates/zerver/api/delete-queue.md +++ b/templates/zerver/api/delete-queue.md @@ -1,4 +1,4 @@ -# Delete a queue +# Delete an event queue {generate_api_description(/events:delete)} diff --git a/templates/zerver/api/delete-stream.md b/templates/zerver/api/delete-stream.md index 7c28cd7393..541d58c349 100644 --- a/templates/zerver/api/delete-stream.md +++ b/templates/zerver/api/delete-stream.md @@ -1,4 +1,4 @@ -# Delete stream +# Delete a stream {generate_api_description(/streams/{stream_id}:delete)} diff --git a/templates/zerver/api/get-linkifiers.md b/templates/zerver/api/get-linkifiers.md index 40a88d26f6..db19d36326 100644 --- a/templates/zerver/api/get-linkifiers.md +++ b/templates/zerver/api/get-linkifiers.md @@ -1,4 +1,4 @@ -# List linkifiers +# Get linkifiers {generate_api_description(/realm/filters:get)} diff --git a/templates/zerver/api/get-own-user.md b/templates/zerver/api/get-own-user.md index 658aafb1fc..7dcdd3efe7 100644 --- a/templates/zerver/api/get-own-user.md +++ b/templates/zerver/api/get-own-user.md @@ -1,4 +1,4 @@ -# Get profile +# Get own user {generate_api_description(/users/me:get)} diff --git a/templates/zerver/api/get-raw-message.md b/templates/zerver/api/get-raw-message.md index 2fd06c9bab..f442dd182c 100644 --- a/templates/zerver/api/get-raw-message.md +++ b/templates/zerver/api/get-raw-message.md @@ -1,4 +1,4 @@ -# Get a raw message +# Get a message's raw markdown {generate_api_description(/messages/{message_id}:get)} diff --git a/templates/zerver/api/get-server-settings.md b/templates/zerver/api/get-server-settings.md index 6767070b65..28873c1384 100644 --- a/templates/zerver/api/get-server-settings.md +++ b/templates/zerver/api/get-server-settings.md @@ -1,4 +1,4 @@ -# Get global settings +# Get server settings {generate_api_description(/server_settings:get)} diff --git a/templates/zerver/api/get-subscription-status.md b/templates/zerver/api/get-subscription-status.md index 8809c01b7e..f462e2dbf4 100644 --- a/templates/zerver/api/get-subscription-status.md +++ b/templates/zerver/api/get-subscription-status.md @@ -1,4 +1,4 @@ -# Get user subscription status +# Get subscription status {generate_api_description(/users/{user_id}/subscriptions/{stream_id}:get)} diff --git a/templates/zerver/api/remove-linkifier.md b/templates/zerver/api/remove-linkifier.md index 44d4534006..75ea5dd5f1 100644 --- a/templates/zerver/api/remove-linkifier.md +++ b/templates/zerver/api/remove-linkifier.md @@ -1,4 +1,4 @@ -# Remove linkifiers +# Remove a linkifier {generate_api_description(/realm/filters/{filter_id}:delete)} diff --git a/templates/zerver/api/subscribe.md b/templates/zerver/api/subscribe.md index 0366701e16..587e47f9ac 100644 --- a/templates/zerver/api/subscribe.md +++ b/templates/zerver/api/subscribe.md @@ -1,4 +1,4 @@ -# Add subscriptions +# Subscribe to a stream {generate_api_description(/users/me/subscriptions:post)} diff --git a/templates/zerver/api/unsubscribe.md b/templates/zerver/api/unsubscribe.md index ab5b4f3863..d19d1a2fcc 100644 --- a/templates/zerver/api/unsubscribe.md +++ b/templates/zerver/api/unsubscribe.md @@ -1,4 +1,4 @@ -# Remove subscriptions +# Unsubscribe from a stream {generate_api_description(/users/me/subscriptions:delete)} diff --git a/templates/zerver/api/update-message-flags.md b/templates/zerver/api/update-message-flags.md index 4176bbdc67..e3874af643 100644 --- a/templates/zerver/api/update-message-flags.md +++ b/templates/zerver/api/update-message-flags.md @@ -1,4 +1,4 @@ -# Update a message's flags +# Update personal message flags {generate_api_description(/messages/flags:post)} diff --git a/templates/zerver/api/update-message.md b/templates/zerver/api/update-message.md index e2f7cc4ea2..adb28534a6 100644 --- a/templates/zerver/api/update-message.md +++ b/templates/zerver/api/update-message.md @@ -1,4 +1,4 @@ -# Update a message +# Edit a message {generate_api_description(/messages/{message_id}:patch)} diff --git a/templates/zerver/api/update-stream.md b/templates/zerver/api/update-stream.md index 2c283c11c9..ab56f93a11 100644 --- a/templates/zerver/api/update-stream.md +++ b/templates/zerver/api/update-stream.md @@ -1,4 +1,4 @@ -# Update stream +# Update a stream {generate_api_description(/streams/{stream_id}:patch)} diff --git a/templates/zerver/api/update-subscription-settings.md b/templates/zerver/api/update-subscription-settings.md index 7d4e619a38..b4411f8408 100644 --- a/templates/zerver/api/update-subscription-settings.md +++ b/templates/zerver/api/update-subscription-settings.md @@ -1,4 +1,4 @@ -# Update subscription properties +# Update subscription settings {generate_api_description(/users/me/subscriptions/properties:post)} diff --git a/templates/zerver/api/update-user-group.md b/templates/zerver/api/update-user-group.md index 7552ec2b14..75228e8092 100644 --- a/templates/zerver/api/update-user-group.md +++ b/templates/zerver/api/update-user-group.md @@ -1,4 +1,4 @@ -# Update User Group +# Update a user group {generate_api_description(/user_groups/{group_id}:patch)} diff --git a/templates/zerver/api/update-user.md b/templates/zerver/api/update-user.md index 81ab51c36a..5ca31a0ba3 100644 --- a/templates/zerver/api/update-user.md +++ b/templates/zerver/api/update-user.md @@ -1,4 +1,4 @@ -# Update User +# Update a user {!api-admin-only.md!} diff --git a/templates/zerver/api/upload-custom-emoji.md b/templates/zerver/api/upload-custom-emoji.md index 2508347495..9b983dcbc4 100644 --- a/templates/zerver/api/upload-custom-emoji.md +++ b/templates/zerver/api/upload-custom-emoji.md @@ -1,4 +1,4 @@ -# Upload a custom emoji +# Upload custom emoji {generate_api_description(/realm/emoji/{emoji_name}:post)} diff --git a/templates/zerver/help/include/rest-endpoints.md b/templates/zerver/help/include/rest-endpoints.md index b011a75c17..86f9cbe721 100644 --- a/templates/zerver/help/include/rest-endpoints.md +++ b/templates/zerver/help/include/rest-endpoints.md @@ -1,58 +1,58 @@ #### Messages -* [Get messages](/api/get-messages) -* [Get a raw message](/api/get-raw-message) * [Send a message](/api/send-message) -* [Update a message](/api/update-message) +* [Upload a file](/api/upload-file) +* [Edit a message](/api/update-message) +* [Delete a message](/api/delete-message) +* [Get messages](/api/get-messages) +* [Construct a narrow](/api/construct-narrow) * [Add an emoji reaction](/api/add-reaction) * [Remove an emoji reaction](/api/remove-reaction) * [Render a message](/api/render-message) -* [Upload a file](/api/upload-file) -* [Delete a message](/api/delete-message) -* [Construct a narrow](/api/construct-narrow) +* [Get a message's raw markdown](/api/get-raw-message) * [Get a message's edit history](/api/get-message-history) -* [Update a message's flags](/api/update-message-flags) +* [Update personal message flags](/api/update-message-flags) * [Mark messages as read in bulk](/api/mark-all-as-read) #### Streams -* [Get all streams](/api/get-streams) * [Get subscribed streams](/api/get-subscriptions) -* [Add subscriptions](/api/subscribe) -* [Update subscription settings](/api/update-subscription-settings) -* [Remove subscriptions](/api/unsubscribe) +* [Subscribe to a stream](/api/subscribe) +* [Unsubscribe from a stream](/api/unsubscribe) * [Get subscription status](/api/get-subscription-status) +* [Update subscription settings](/api/update-subscription-settings) +* [Get all streams](/api/get-streams) +* [Get stream ID](/api/get-stream-id) +* [Create a stream](/api/create-stream) +* [Update a stream](/api/update-stream) +* [Delete a stream](/api/delete-stream) * [Get topics in a stream](/api/get-stream-topics) * [Topic muting](/api/mute-topic) -* [Create a stream](/api/create-stream) -* [Get stream ID](/api/get-stream-id) -* [Delete a stream](/api/delete-stream) -* [Update a stream](/api/update-stream) #### Users * [Get all users](/api/get-users) +* [Get own user](/api/get-own-user) * [Get a user](/api/get-user) +* [Update a user](/api/update-user) +* [Create a user](/api/create-user) * [Deactivate a user](/api/deactivate-user) * [Reactivate a user](/api/reactivate-user) -* [Update a user](/api/update-user) -* [Get profile](/api/get-own-user) -* [Create a user](/api/create-user) * [Set "typing" status](/api/set-typing-status) * [Get user presence](/api/get-user-presence) -* [Get all user groups](/api/get-user-groups) +* [Get attachments](/api/get-attachments) * [Update notification settings](/api/update-notification-settings) +* [Get user groups](/api/get-user-groups) * [Create a user group](/api/create-user-group) * [Update a user group](/api/update-user-group) * [Delete a user group](/api/remove-user-group) -* [Get attachments](/api/get-attachments) #### Server & organizations * [Get server settings](/api/get-server-settings) -* [List linkifiers](/api/get-linkifiers) -* [Create linkifiers](/api/add-linkifier) -* [Remove linkifiers](/api/remove-linkifier) +* [Get linkifiers](/api/get-linkifiers) +* [Add a linkifier](/api/add-linkifier) +* [Remove a linkifier](/api/remove-linkifier) * [Get all custom emoji](/api/get-custom-emoji) * [Upload custom emoji](/api/upload-custom-emoji) diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index 237dabee91..bd46ddd40b 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -1191,7 +1191,8 @@ paths: operationId: update_message_flags tags: ["messages"] description: | - Add or remove flags in a list of messages. + Add or remove personal message flags like `read` and `starred` + on a collection of message IDs. `POST {{ api_url }}/v1/messages/flags`