docs: Add notification inband mode for LiveObjects#3158
docs: Add notification inband mode for LiveObjects#3158
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
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 |
GregHolmes
force-pushed
the
ait-59-inband-docs-update
branch
from
acd6ddc to
3316e53
Compare
GregHolmes
left a comment
GregHolmes
left a comment
There was a problem hiding this comment.
No real big issues here! A broken json example, and the rest are comments. Let me know what you think.
| { | ||
| "name": "[meta]objects", | ||
| "data": { | ||
| { |
There was a problem hiding this comment.
| { |
There's an extra { on this line.
| ## 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. |
There was a problem hiding this comment.
| 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. |
| ## 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. |
There was a problem hiding this comment.
Do we need to know what these contents are here?
There was a problem hiding this comment.
I think I'll remove this line. Everything is explained below it adds nothing.
|
|
||
| There are two inband modes available: | ||
|
|
||
| | Mode | Description | |
There was a problem hiding this comment.
| | 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.
There was a problem hiding this comment.
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.
kaschula
force-pushed
the
ait-59-inband-docs-update
branch
from
3316e53 to
41cc3be
Compare
2 participants
Summary
notificationinband mode for LiveObjectsChanges
New notification mode documentation:
notificationmode sends a notification when an objects operation is received (not just when state changes)linkproperty for fetching state via REST APIImproved objects mode documentation:
Updated mode comparison table:
objectsandnotificationmodesChecklist