Sync Control API spec with latest Control API source

[sacOO7]

• Related to https://ably.atlassian.net/browse/DX-144
• Supersedes [DX-144] Update control API spec for missing fields #3257

Brings static/open-specs/control-v1.yaml fully in line with the Control API implementation and its CI-enforced generated swagger document. After this change, a structural diff (schemas, paths, properties, required fields) between the two specs shows no remaining gaps.

Added

• Rule target fields: exchange (amqp/external), primarySite + provisionedCapacity (postgres outbox and MongoDB ingress), watch (MongoDB ingress), status on amqp/external and Google Cloud Function create schemas
• Legacy webhook rule type on rule_response (returned for batch-mode rules predating the http type)
• Endpoints: GET /me/accounts and POST /help with their me_accounts, help_request and help_response schemas
• inProgress + required lists on account/app stats responses

Fixed

• Namespace schemas: missing type on conflationEnabled, incorrect batchingInterval description, nullable on batching/conflation fields, mutableMessages description now notes it requires persisted: true (per review feedback on [DX-144] Update control API spec for missing fields #3257)
• key_response.name marked nullable; unsupported_rule_response.target allows additional properties
• Docs page now points at the spec's new home in ably/docs (OpenAPI link + Postman import URL)

Deliberately excluded (per #3257 review)

batchingPolicy and batchingConflationKey — accepted by the Control API controller but not returned in responses nor part of the API's documented contract (see DX-789).

Verification

Every added field was verified against the Control API source (controllers, jbuilder views, schema definitions). The spec validates cleanly with Redocly (remaining warnings are pre-existing style conventions shared by the whole file).

🤖 Generated with Claude Code

[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: 3caf79e9-04ec-40b7-8a3d-9924114ff441

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 fix/dx-144-control-api-spec-sync

---

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

[Copilot]

Pull request overview

Updates the Control API OpenAPI specification and associated docs to match the current Control API implementation / generated swagger, closing remaining structural gaps.

Changes:

• Added new Control API endpoints (GET /me/accounts, POST /help) and their request/response schemas.
• Expanded rule/target schemas (e.g., exchange, primarySite, provisionedCapacity, watch, legacy webhook rule response) and adjusted a few existing schema details (e.g., nullability, descriptions, required lists).
• Updated the Control API docs page to point to the spec in its new location in ably/docs.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
static/open-specs/control-v1.yaml	Adds new endpoints/schemas and syncs multiple schema details to align with Control API output.
src/pages/docs/platform/account/control-api.mdx	Updates OpenAPI and Postman-import references to the new spec location.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.