docs icon indicating copy to clipboard operation
docs copied to clipboard

Add message/client-summary endpoint docs

Open vladvelici opened this issue 3 months ago • 1 comments

Description

Add client-summary endpoint docs. https://ably.atlassian.net/browse/CHA-1199

I wasn't sure how to document the response of the summary. It's the just the annotation summary, clipped, and only including the entries that are relevant for the requested clientId. Should I add an example? I just copied the text that describes the summary from the _message_annotations partial.

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.

vladvelici avatar Oct 07 '25 15:10 vladvelici

[!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 (beta)
  • [ ] Create PR with unit tests
  • [ ] Post copyable unit tests in a comment
  • [ ] Commit unit tests in branch annotations-rest-api-client-summary

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.

coderabbitai[bot] avatar Oct 07 '25 15:10 coderabbitai[bot]