docs: Add notification inband mode for LiveObjects by kaschula · Pull Request #3158 · ably/docs

kaschula · 2026-01-27T10:43:15Z

Summary

Add documentation for the new notification inband mode for LiveObjects
Reorganize the inband objects page to clearly distinguish between the two available modes
Add JSON examples for Counter and Map object message formats as the REST API reference they previously linked to have been removed.

Changes

New notification mode documentation:

Explains that notification mode sends a notification when an objects operation is received (not just when state changes)
Documents the message format with the link property for fetching state via REST API
Clarifies that no initial state is sent on attach
Provides usage guidance on when to use each mode

Improved objects mode documentation:

Reorganized existing content under a dedicated "Objects mode" section
Added concrete JSON examples showing the message format for both Counter and Map objects

Updated mode comparison table:

Added a comparison table at the top showing both objects and notification modes
Updated enable section to show how to configure either mode

Checklist

Commits have been rebased.
Linting has been run against the changed file(s).
The PR adheres to the writing style guide and contribution guide.

coderabbitai · 2026-01-27T10:43:24Z

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.

Use the checkbox below for a quick retry:

🔍 Trigger review

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch ait-59-inband-docs-update

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

GregHolmes

No real big issues here! A broken json example, and the rest are comments. Let me know what you think.

GregHolmes · 2026-01-28T11:42:11Z

src/pages/docs/liveobjects/inband-objects.mdx

+{
+  "name": "[meta]objects",
+  "data": {
+  {


Suggested change

{

There's an extra { on this line.

GregHolmes · 2026-01-28T11:47:57Z

src/pages/docs/liveobjects/inband-objects.mdx

 ## Subscribe to updates <a id="inband-objects-subscribe"/>

-When using inband objects, the client will receive special `[meta]objects` messages whenever the objects on the channel are updated. These messages provide a snapshot of the current set of objects on the channel.
+When using inband objects, the client will receive special `[meta]objects` messages whenever the objects on the channel are updated. The content of these messages depends on which mode you are using.


Suggested change

When using inband objects, the client will receive special `[meta]objects` messages whenever the objects on the channel are updated. The content of these messages depends on which mode you are using.

When using inband objects, the client will receive special `[meta]objects` messages whenever the objects on the channel are updated. The contents of these messages depends on which mode you are using.

GregHolmes · 2026-01-28T11:48:07Z

src/pages/docs/liveobjects/inband-objects.mdx

 ## Subscribe to updates <a id="inband-objects-subscribe"/>

-When using inband objects, the client will receive special `[meta]objects` messages whenever the objects on the channel are updated. These messages provide a snapshot of the current set of objects on the channel.
+When using inband objects, the client will receive special `[meta]objects` messages whenever the objects on the channel are updated. The content of these messages depends on which mode you are using.


Do we need to know what these contents are here?

I think I'll remove this line. Everything is explained below it adds nothing.

GregHolmes · 2026-01-28T11:55:48Z

src/pages/docs/liveobjects/inband-objects.mdx


+There are two inband modes available:
+
+| Mode           | Description                                                                                                                                                                                        |


Suggested change

| Mode | Description |

| Mode | Description |

| --- | --- |

| `objects` | Sends the full state of all objects on the channel. |

This isn't a big issue, but you don't need to fill to match the size of the table. The above would do for the first 3 lines of the table. MDX will render it correctly either way.

Apologies, my IDE insisted.

Document the new `notification` inband mode for LiveObjects which notifies clients when objects operations are received without sending the full state data.

We now stop sending inband object state sync if an object is over the max maessage size.

kaschula · 2026-02-11T11:00:34Z

@GregHolmes Please could re-review I have updated the docs with some additional information a change that is due to be merged - 6e401e9

GregHolmes

Thanks @kaschula , I've added a fixup for a couple sentence change and adding a sentence between headers.

All approved.
Just need to squash fixup (I'll keep it in place atm for you to read)

kaschula · 2026-02-13T11:38:38Z

Thanks @kaschula , I've added a fixup for a couple sentence change and adding a sentence between headers.

All approved. Just need to squash fixup (I'll keep it in place atm for you to read)

Thanks Greg, I have read them and it makes sense. Do you want me to do the rebase? I don't want to merge just yet till the fix rolls out in production next week.

GregHolmes · 2026-02-13T11:40:22Z

Thanks @kaschula , I've added a fixup for a couple sentence change and adding a sentence between headers.
All approved. Just need to squash fixup (I'll keep it in place atm for you to read)

Thanks Greg, I have read them and it makes sense. Do you want me to do the rebase? I don't want to merge just yet till the fix rolls out in production next week.

You're welcome to rebase to squash the fixup.
If not, I can do after the standup.

kaschula · 2026-02-13T11:47:22Z

Thanks @kaschula , I've added a fixup for a couple sentence change and adding a sentence between headers.
All approved. Just need to squash fixup (I'll keep it in place atm for you to read)

Thanks Greg, I have read them and it makes sense. Do you want me to do the rebase? I don't want to merge just yet till the fix rolls out in production next week.

You're welcome to rebase to squash the fixup. If not, I can do after the standup.

I'll keep ownership and I will release it when the changes rollout.

kaschula requested a review from GregHolmes January 27, 2026 10:43

GregHolmes force-pushed the ait-59-inband-docs-update branch from acd6ddc to 3316e53 Compare January 28, 2026 10:49

GregHolmes requested changes Jan 28, 2026

View reviewed changes

kaschula force-pushed the ait-59-inband-docs-update branch from 3316e53 to 41cc3be Compare January 29, 2026 11:30

kaschula requested a review from GregHolmes January 29, 2026 12:01

GregHolmes approved these changes Feb 2, 2026

View reviewed changes

docs: Add notification inband mode for LiveObjects

b4bfcb1

Document the new `notification` inband mode for LiveObjects which notifies clients when objects operations are received without sending the full state data.

GregHolmes force-pushed the ait-59-inband-docs-update branch from 41cc3be to b4bfcb1 Compare February 8, 2026 21:35

docs: Document 64KB size limit for inband objects

6e401e9

We now stop sending inband object state sync if an object is over the max maessage size.

kaschula requested a review from GregHolmes February 11, 2026 11:00

fixup! docs: Document 64KB size limit for inband objects

758609b

GregHolmes approved these changes Feb 12, 2026

View reviewed changes

GregHolmes added the Do not merge When the PR is in progress do not merge label Feb 13, 2026

	When using inband objects, the client will receive special `[meta]objects` messages whenever the objects on the channel are updated. The content of these messages depends on which mode you are using.
	When using inband objects, the client will receive special `[meta]objects` messages whenever the objects on the channel are updated. The contents of these messages depends on which mode you are using.

Conversation

kaschula commented Jan 27, 2026

Summary

Changes

Checklist

Uh oh!

coderabbitai bot commented Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

GregHolmes left a comment

Choose a reason for hiding this comment

Uh oh!

GregHolmes Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

GregHolmes Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

GregHolmes Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

kaschula Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

GregHolmes Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

kaschula Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

kaschula commented Feb 11, 2026

Uh oh!

GregHolmes left a comment

Choose a reason for hiding this comment

Uh oh!

kaschula commented Feb 13, 2026

Uh oh!

GregHolmes commented Feb 13, 2026

Uh oh!

kaschula commented Feb 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

coderabbitai bot commented Jan 27, 2026 •

edited

Loading