DX-1211: RealtimeAnnotations & RestAnnotations interface docstrings#2245
Draft
umair-ably wants to merge 4 commits into
Draft
DX-1211: RealtimeAnnotations & RestAnnotations interface docstrings#2245umair-ably wants to merge 4 commits into
umair-ably wants to merge 4 commits into
Conversation
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
github-actions
Bot
temporarily deployed
to
staging/pull/2245/bundle-report
umair-ably
force-pushed
the
DX-1211/realtimepresence-docstrings
branch
from
0c60917 to
1da8dbb
Compare
umair-ably
force-pushed
the
DX-1211/annotations-docstrings
branch
from
3c629aa to
c408dc2
Compare
github-actions
Bot
temporarily deployed
to
staging/pull/2245/bundle-report
umair-ably
force-pushed
the
DX-1211/realtimepresence-docstrings
branch
from
1da8dbb to
31891bf
Compare
umair-ably
force-pushed
the
DX-1211/annotations-docstrings
branch
from
c408dc2 to
3261064
Compare
github-actions
Bot
temporarily deployed
to
staging/pull/2245/bundle-report
github-actions
Bot
temporarily deployed
to
staging/pull/2245/bundle-report
umair-ably
force-pushed
the
DX-1211/realtimepresence-docstrings
branch
from
31891bf to
2c3359d
Compare
umair-ably
force-pushed
the
DX-1211/annotations-docstrings
branch
from
3261064 to
220594c
Compare
github-actions
Bot
temporarily deployed
to
staging/pull/2245/bundle-report
github-actions
Bot
temporarily deployed
to
staging/pull/2245/bundle-report
umair-ably
force-pushed
the
DX-1211/annotations-docstrings
branch
from
220594c to
d8bfef6
Compare
umair-ably
force-pushed
the
DX-1211/realtimepresence-docstrings
branch
from
2c3359d to
97f56a1
Compare
github-actions
Bot
temporarily deployed
to
staging/pull/2245/bundle-report
github-actions
Bot
temporarily deployed
to
staging/pull/2245/bundle-report
umair-ably
force-pushed
the
DX-1211/annotations-docstrings
branch
from
d8bfef6 to
4a5497a
Compare
umair-ably
force-pushed
the
DX-1211/realtimepresence-docstrings
branch
from
97f56a1 to
e2de3ee
Compare
github-actions
Bot
temporarily deployed
to
staging/pull/2245/bundle-report
github-actions
Bot
temporarily deployed
to
staging/pull/2245/bundle-report
… subscribe hint capability branch serialFromMsgOrSerial/constructValidateAnnotation now take the calling method's name, so annotations.get()/delete() failures no longer report "annotations.publish()". The 93001 hint told users to check the annotation-subscribe capability "if the subsequent attach is rejected", but a missing capability does not reject the attach (live-traced: the server silently grants fewer modes than requested); the hint now distinguishes the channel-rule case (attach rejected) from the capability case (attach succeeds, error persists). Co-Authored-By: Claude Fable 5 (1M context) <noreply@anthropic.com>
…cstrings (prerequisites, side-effects, failure modes) Co-Authored-By: Claude Fable 5 (1M context) <noreply@anthropic.com>
delete() has existed in the RestAnnotations implementation since 04fed9c (which declared it only on RealtimeAnnotations), so the method works at runtime but TypeScript users cannot call it. Verified live that the server accepts REST-published deletes. Co-Authored-By: Claude Fable 5 (1M context) <noreply@anthropic.com>
…ned at the rule prerequisite; fold parentheticals Removes the conceptual @see stacked on subscribe/publish/delete, linking https://ably.com/docs/messages/annotations inline where each block states the namespace-rule prerequisite instead. Promotes the summary-updates parenthetical to a sentence and removes the parentheticals from the serial validation message. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
umair-ably
force-pushed
the
DX-1211/annotations-docstrings
branch
from
4a5497a to
bfed6fc
Compare
umair-ably
force-pushed
the
DX-1211/realtimepresence-docstrings
branch
from
e2de3ee to
9e59a94
Compare
github-actions
Bot
temporarily deployed
to
staging/pull/2245/bundle-report
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stacked on #2244. One commit per change:
RealtimeAnnotations/RestAnnotationsdocstrings so prerequisites, side-effects and failure modes are discoverable at the call site (the DX-1211 effort): the default-offannotation_subscribemode, the mutable-messages channel rule, theannotation-publish/annotation-subscribecapabilities, the unencrypted-annotation-data caveat, and each member's reject behaviour. Server-side failure shapes were verified by live traces against sandbox.RestAnnotations.deletedeclaration — the implementation has existed since 04fed9c but was never declared on the interface, so the working method is uncallable from TypeScript. Public API addition (changelog-worthy).annotations.publish(), and the 93001 hint no longer tells users to expect a rejected attach for a missing capability (the server actually silently grants fewer modes; live-traced).🤖 Generated with Claude Code