Skip to content

Conversation

@SimonWoolf
Copy link
Member

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)

@SimonWoolf SimonWoolf requested a review from m-hulbert November 4, 2025 21:41
@coderabbitai
Copy link

coderabbitai bot commented Nov 4, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Note

Other AI code review bot(s) detected

CodeRabbit 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)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch updates-deletes

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@SimonWoolf SimonWoolf requested review from GregHolmes, Copilot and rainbowFi and removed request for m-hulbert November 4, 2025 21:42
Copy link

Copilot AI left a 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, and version properties 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.

@SimonWoolf
Copy link
Member Author

@copilot apply all of your suggestions

Copy link

Copilot AI commented Nov 4, 2025

@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.

Copilot AI and others added 2 commits November 4, 2025 22:59
Apply PR review suggestions: fix typos, grammar, and incorrect method calls

This comment was marked as duplicate.

@franrob-projects franrob-projects added the review-app Create a Heroku review app label Nov 10, 2025
@franrob-projects franrob-projects temporarily deployed to ably-docs-updates-delet-opfutk November 10, 2025 15:26 Inactive
@franrob-projects franrob-projects self-requested a review November 11, 2025 10:58
Copy link
Contributor

@franrob-projects franrob-projects left a 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review-app Create a Heroku review app

Development

Successfully merging this pull request may close these issues.

3 participants