api_docs: Rename titles of endpoint docs and add missing links.

Renames titles of endpoints to make them consistent across left sidebar and
main documentation page.

Adds missing links in API documentation.
This commit is contained in:
Vector73 2024-06-28 08:22:38 +05:30 committed by Tim Abbott
parent d336d8affc
commit 43eb591ed6
2 changed files with 14 additions and 13 deletions

View File

@ -10,7 +10,7 @@
* [Remove an emoji reaction](/api/remove-reaction)
* [Render a message](/api/render-message)
* [Fetch a single message](/api/get-message)
* [Check if messages match narrow](/api/check-messages-match-narrow)
* [Check if messages match a narrow](/api/check-messages-match-narrow)
* [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)
@ -39,7 +39,7 @@
* [Subscribe to a channel](/api/subscribe)
* [Unsubscribe from a channel](/api/unsubscribe)
* [Get subscription status](/api/get-subscription-status)
* [Get all subscribers](/api/get-subscribers)
* [Get channel subscribers](/api/get-subscribers)
* [Update subscription settings](/api/update-subscription-settings)
* [Get all channels](/api/get-streams)
* [Get a channel by ID](/api/get-stream-by-id)
@ -69,7 +69,7 @@
* [Get a user's status](/api/get-user-status)
* [Update your status](/api/update-status)
* [Set "typing" status](/api/set-typing-status)
* [Get user presence](/api/get-user-presence)
* [Get a user's presence](/api/get-user-presence)
* [Get presence of all users](/api/get-presence)
* [Update your presence](/api/update-presence)
* [Get attachments](/api/get-attachments)
@ -80,10 +80,10 @@
* [Update a user group](/api/update-user-group)
* [Delete a user group](/api/remove-user-group)
* [Update user group members](/api/update-user-group-members)
* [Update user group subgroups](/api/update-user-group-subgroups)
* [Update subgroups of a user group](/api/update-user-group-subgroups)
* [Get user group membership status](/api/get-is-user-group-member)
* [Get user group members](/api/get-user-group-members)
* [Get subgroups of user group](/api/get-user-group-subgroups)
* [Get subgroups of a user group](/api/get-user-group-subgroups)
* [Mute a user](/api/mute-user)
* [Unmute a user](/api/unmute-user)
* [Get all alert words](/api/get-alert-words)
@ -133,3 +133,4 @@
* [Remove an APNs device token](/api/remove-apns-token)
* [Add an FCM registration token](/api/add-fcm-token)
* [Remove an FCM registration token](/api/remove-fcm-token)
* [Create BigBlueButton video call](/api/create-big-blue-button-video-call)

View File

@ -7232,7 +7232,7 @@ paths:
/messages/render:
post:
operationId: render-message
summary: Render message
summary: Render a message
tags: ["messages"]
description: |
Render a message to HTML.
@ -7413,7 +7413,7 @@ paths:
/messages/{message_id}/read_receipts:
get:
operationId: get-read-receipts
summary: Get the list of IDs of users who have read a message.
summary: Get a message's read receipts
tags: ["messages"]
description: |
Returns a list containing the IDs for all users who have
@ -7580,7 +7580,7 @@ paths:
/messages/{message_id}:
get:
operationId: get-message
summary: Fetch a single message.
summary: Fetch a single message
tags: ["messages"]
description: |
Given a message ID, return the message object.
@ -8475,7 +8475,7 @@ paths:
/users/{user_id_or_email}/presence:
get:
operationId: get-user-presence
summary: Get user presence
summary: Get a user's presence
tags: ["users"]
description: |
Get the presence status for a specific user.
@ -12161,7 +12161,7 @@ paths:
}
patch:
operationId: reorder-linkifiers
summary: Reorder all linkifiers
summary: Reorder linkifiers
tags: ["server_and_organizations"]
description: |
Change the order that the regular expression patterns in the organization's
@ -18233,7 +18233,7 @@ paths:
/streams/{stream_id}/members:
get:
operationId: get-subscribers
summary: Get the subscribers of a channel
summary: Get channel subscribers
tags: ["channels"]
description: |
Get all users subscribed to a channel.
@ -18727,7 +18727,7 @@ paths:
/streams/{stream_id}/email_address:
get:
operationId: get-stream-email-address
summary: Get the email address of a channel
summary: Get channel's email address
tags: ["channels"]
description: |
Get email address of a channel.
@ -19503,7 +19503,7 @@ paths:
$ref: "#/components/responses/SimpleSuccess"
get:
operationId: get-user-group-subgroups
summary: Get subgroups of the user group
summary: Get subgroups of a user group
tags: ["users"]
description: |
Get the subgroups of a [user group](/help/user-groups).