Add message/client-summary endpoint docs

[vladvelici]

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.

[coderabbitai]

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[m-hulbert]

The base branch likely needs rebasing as well, but I recently updated all endpoints to the new format (main.realtime.ably.net)

[SimonWoolf]

can I ask why we ended up with forClientId on this endpoint? Every other rest endpoint that accepts a client id parameter uses clientId

[vladvelici]

I thought clientId is used for authentication, to act on behalf of the given clientId. This endpoint should allow you to fetch the summary of any client, not just yours.

I mean if you don't have access to act on behalf of another clientId you can still fetch a sliced summary for that clientId.