Skip to content

Update LiveObjects docs for aggregate limits and notification mode#3264

Merged
zknill merged 1 commit intomainfrom
zak/live-objects-size-notifications
Mar 13, 2026
Merged

Update LiveObjects docs for aggregate limits and notification mode#3264
zknill merged 1 commit intomainfrom
zak/live-objects-size-notifications

Conversation

@zknill
Copy link
Contributor

@zknill zknill commented Mar 11, 2026

  • Clarify that the 6.5 MB object size limit is an aggregate across all objects on a channel, with no limit on object count
  • Document the 64 KiB per-operation size constraint and that objects can grow beyond it via incremental updates
  • Note that large objects may be split across multiple sync messages, affecting billing message counts
  • Add documentation for the new 'notification' inband objects mode, which sends a REST API link instead of streaming full state
  • Restructure inband-objects.mdx into 'objects mode' and 'notification mode' sections
  • Fix limits.mdx description to say "aggregate size of all objects"

@zknill zknill requested a review from mschristensen March 11, 2026 17:13
@coderabbitai
Copy link

coderabbitai bot commented Mar 11, 2026

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.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 5917f387-48c9-446e-85c4-a59fb0f3c945

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 zak/live-objects-size-notifications
📝 Coding Plan
  • Generate coding plan for human review comments

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.

Tip

You can disable the changed files summary in the walkthrough.

Disable the reviews.changed_files_summary setting to disable the changed files summary in the walkthrough.

@mschristensen mschristensen added the review-app Create a Heroku review app label Mar 13, 2026
@ably-ci ably-ci temporarily deployed to ably-docs-zak-live-obje-qiba1x March 13, 2026 08:30 Inactive
Copy link
Contributor

@mschristensen mschristensen left a comment

Choose a reason for hiding this comment

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

LGTM, although I'll leave @kaschula to review the inband objects changes

Copy link
Contributor

@kaschula kaschula left a comment

Choose a reason for hiding this comment

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

Inband side looks good. I have an open PR with some inband changes which contains a few more details interms of examples and expected response formats. Go ahead and merge this I will rebase mine and add any extra bits.

@zknill zknill force-pushed the zak/live-objects-size-notifications branch from 4214e1b to a7585c9 Compare March 13, 2026 11:15
@zknill zknill enabled auto-merge March 13, 2026 11:15
@ably-ci ably-ci temporarily deployed to ably-docs-zak-live-obje-qiba1x March 13, 2026 11:15 Inactive
- Clarify that the 6.5 MB object size limit is an aggregate across
  all objects on a channel, with no limit on object count
- Document the 64 KiB per-operation size constraint and that objects
  can grow beyond it via incremental updates
- Note that large objects may be split across multiple sync messages,
  affecting billing message counts
- Add documentation for the new 'notification' inband objects mode,
  which sends a REST API link instead of streaming full state
- Restructure inband-objects.mdx into 'objects mode' and
  'notification mode' sections
- Fix limits.mdx description to say "aggregate size of all objects"
@zknill zknill force-pushed the zak/live-objects-size-notifications branch from a7585c9 to 2e2ac11 Compare March 13, 2026 11:36
@ably-ci ably-ci temporarily deployed to ably-docs-zak-live-obje-qiba1x March 13, 2026 11:36 Inactive
@zknill zknill merged commit 9e12658 into main Mar 13, 2026
7 checks passed
@zknill zknill deleted the zak/live-objects-size-notifications branch March 13, 2026 11:45
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.

4 participants