-
Notifications
You must be signed in to change notification settings - Fork 46
Add docs for message updates and deletes #2946
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
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 Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive documentation for the message updates and deletes feature in Ably, which allows clients to update and delete previously published messages on channels. The changes document an experimental feature that enables use cases like message editing, content moderation, and gradual message building.
Key changes:
- New documentation page explaining message update/delete functionality, capabilities, and version history
- API reference updates for REST and Realtime SDKs to document new methods (
getMessage,updateMessage,deleteMessage,getMessageVersions) - Updates to message type definitions to include
action,serial, andversionproperties across multiple SDKs - New REST API endpoints documentation for message operations
- Navigation updates to include the new documentation page
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| src/pages/docs/messages/updates-deletes.mdx | New comprehensive documentation page for message update and delete functionality |
| src/pages/docs/messages/index.mdx | Updated message properties table to include serial and version fields |
| src/pages/docs/auth/capabilities.mdx | Added four new capabilities for message update/delete operations |
| src/pages/docs/api/rest-sdk/messages.mdx | Added MessageVersion type definition |
| src/pages/docs/api/rest-sdk/channels.mdx | Added getMessage, updateMessage, deleteMessage, and getMessageVersions method documentation |
| src/pages/docs/api/realtime-sdk/messages.mdx | Added MessageVersion type and updated message property documentation |
| src/pages/docs/api/realtime-sdk/channels.mdx | Added getMessage, updateMessage, deleteMessage, and getMessageVersions method documentation |
| src/data/nav/pubsub.ts | Added navigation entry for the new updates-deletes documentation page |
| content/partials/types/_message_action.textile | Expanded MessageAction enum documentation to include multiple language implementations |
| content/partials/types/_message.textile | Updated message properties to include version field and updated serial description |
| content/api/rest-sdk/channels.textile | New file with complete REST SDK channels API documentation including message operations |
| content/api/rest-api.textile | Added REST API endpoint documentation for get message, update message, delete message, and message versions |
| content/api/realtime-sdk/types.textile | Updated MessageAction type documentation structure |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@copilot apply all of your suggestions |
|
@SimonWoolf I've opened a new pull request, #2947, to work on those changes. Once the pull request is ready, I'll request review from you. |
Co-authored-by: SimonWoolf <[email protected]>
Apply PR review suggestions: fix typos, grammar, and incorrect method calls
This comment was marked as duplicate.
This comment was marked as duplicate.
franrob-projects
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved. But I'll manually transfer these updates into a new PR as we have now moved to MDX.
I'll supersede this pr and tag.
Main new page: /docs/messages/updates-deletes
(but the majority of the diff is in the api docs, which, sorry to complain, seem to be getting increasingly painful to make any changes to -- there now seem to be six near-duplicate copies of the Message fields table in various places which needed updating and I wouldn't be surprised if there were more I missed)