Chat: Adding rest api documentation to chat #2478
Draft
+713
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ng, and deletion.
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
The REST API documentation for sending, updating, deleting, and retrieving chat messages has been moved. It is now exposed via openAPI and is defined in the chat.yaml file.
… REST API section.
The X-Ably-Version header was redundant and not strictly required.
AndyTWF
reviewed
Mar 17, 2025
| title: Ably Chat REST API | ||
| version: 1.0.0 | ||
| paths: | ||
| /chat/{version}/rooms/{roomId}/messages: |
There was a problem hiding this comment.
For some reason, the /chat/version part of this doesn't seem to be appearing?
There was a problem hiding this comment.
Hmm, could you try clearing your node_module file, reinstall and then rebuild?
Removing envelope param, this can be governed by content type. Adding moderation failure response.
splindsay-92
force-pushed
the
chat/adding-rest-api-documentation
branch
from
9388c24 to
fea74d1
Compare
AndyTWF
reviewed
Mar 19, 2025
Added per-response error examples. Added supported content-types. Some small changes in wording for clarity.
There was a problem hiding this comment.
Added some small comments, but please see conversation in topic-product for more context in regards to the location of this etc.
Updated the production server URL to "https://main.realtime.ably.net/".
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR aims to add documentation to cover the various chat REST API endpoints;
Checklist