Skip to content

Chat: Move to V4 Message Structure #2766

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Chat: Move to V4 Message Structure #2766

wants to merge 10 commits into from

Conversation

splindsay-92
Copy link
Contributor

@splindsay-92 splindsay-92 commented Aug 14, 2025 •
edited
Loading

Description

CHA-1159

Updates the docs to represent the changed Pv4 format.

  • Message.Version is now an object, the original serial string is nested within.
  • Operations field has been removed, and data contained within has been moved to the new Message.Version object.
  • V4 endpoints no longer return nested responses (expect in cases of errors), and message send now returns a synthesized full chat message.

Checklist

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Aug 14, 2025 •
edited
Loading

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.

✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chat/move-to-pv4

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.

@splindsay-92 splindsay-92 force-pushed the chat/move-to-pv4 branch 2 times, most recently from 456ad1e to 57dfd7e Compare September 22, 2025 11:43
@splindsay-92 splindsay-92 marked this pull request as ready for review September 22, 2025 11:46
@splindsay-92 splindsay-92 added the review-app Create a Heroku review app label Sep 22, 2025
@ably-ci ably-ci temporarily deployed to ably-docs-chat-move-to--zk3cte September 22, 2025 11:47 Inactive
@ably-ci ably-ci temporarily deployed to ably-docs-chat-move-to--zk3cte September 22, 2025 11:52 Inactive
@ably-ci ably-ci temporarily deployed to ably-docs-chat-move-to--zk3cte September 22, 2025 11:55 Inactive
@splindsay-92 splindsay-92 requested review from AndyTWF and vladvelici and removed request for AndyTWF September 22, 2025 11:56
AndyTWF
AndyTWF reviewed Sep 22, 2025
View reviewed changes
vladvelici
vladvelici reviewed Sep 22, 2025
View reviewed changes
vladvelici
vladvelici reviewed Sep 22, 2025
View reviewed changes
Copy link
Contributor

@vladvelici vladvelici left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @AndyTWF's comments about the version vs action wording. Looks good otherwise!

Maybe not for this PR as it's not introduced here, but should we ever mention that the timestamps are in ms? unix-timestamp doesn't mean anything in the OpenAPI spec but I think "unix timestamp" implies seconds by default. Maybe just call it unix-timestamp-ms?

@ably-ci ably-ci temporarily deployed to ably-docs-chat-move-to--zk3cte September 22, 2025 18:06 Inactive
AndyTWF
AndyTWF reviewed Sep 22, 2025
View reviewed changes
@ably-ci ably-ci temporarily deployed to ably-docs-chat-move-to--zk3cte September 24, 2025 10:10 Inactive
@splindsay-92
Chat: Update message structure to ProtocolV4.
67b07c3 
- Replace `createdAt` with `timestamp`.
- Update `version` field to include nested properties (`serial`, `timestamp`, `clientId`, `description`, `metadata`).
@splindsay-92
Chat: Update OpenAPI spec for ProtocolV4.
b94cfdd 
- Bump API version to 4.0.0.
- Replace `createdAt` with `timestamp`.
- Update `version` to include nested properties (`serial`, `timestamp`, `clientId`, `description`, `metadata`).

- send endpoint now returns a nested message object, which contains serial and timestamp.
- update and delete endpoints no longer return version and timestamp, these are contained within the returned message struct.
@splindsay-92
Update chat openAPI yaml.
7831631 
REST endpoints now return the message fields at the root level of the response payload
@splindsay-92
Refactor chat OpenAPI spec to use $ref for the message schema.
f8c5af3
@splindsay-92
use version.serial in ordering docs
8158151
@splindsay-92
formatting fix in openAPI
177f326
@splindsay-92
Update media doc to use version.serial
520bda7
@splindsay-92
Refactor based on PR comments
be9050a
@splindsay-92
fix message table formatting
b441cfc
@splindsay-92 splindsay-92 added review-app Create a Heroku review app and removed review-app Create a Heroku review app labels Sep 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vladvelici vladvelici vladvelici left review comments

@AndyTWF AndyTWF AndyTWF approved these changes

Assignees
No one assigned
Labels
review-app Create a Heroku review app
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@splindsay-92 @vladvelici @AndyTWF @ably-ci