[AIT-295] Update Swift API references docs for protocol v5 changes

[maratal]

Description

Updates similar to #3134 re API reference. Examples were added in the previous PR.

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.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: dc86b6cc-b1e0-42ae-ba6c-f208866ae29f

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
• Commit unit tests in branch AIT-295-update-api-refs-for-swift

---

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.}

[lawrence-forooghian]

Hey @maratal, sorry for taking a while to get back to you on this one. I wanted to get Claude to review this for me but there wasn't an authoritative source of information on the ably-cocoa Swift API for it to cross-reference against. Now there is: https://sdk.ably.com/builds/ably/ably-cocoa/main/markdown-api-reference/api.md. I got Claude to review it; in particular I wanted to know:

• whether the references you've added are accurate (compared to the Markdown reference) — it said no, there are some inaccuracies
• whether we should be using the ART prefixes (i.e. how do we do it elsewhere in these references) — it said we should be

— I don't have the time right now to check through its output and write it up as a review, so could I please ask that you get Claude to do this review for you and address the feedback?

[maratal]

FYI @lawrence-forooghian — while reviewing the Swift blocks in this PR, I noticed there are pre-existing usages of Swift types without the ART prefix in parameter description tables elsewhere in the docs (outside the scope of this PR).

Examples found in existing <If lang="objc,swift"> blocks in realtime-sdk/channels.mdx:

• ErrorInfo without ART prefix (lines 1488, 1605) — should be ARTErrorInfo

These are in the channel state subscription methods (on/once/off), not touched by this PR. Worth a follow-up fix in a separate PR.

[lawrence-forooghian]

Please could you squash the commits?

[maratal]

Please could you squash the commits?

Sure