Skip to content
This repository was archived by the owner on Aug 10, 2026. It is now read-only.

Commit 5031308

Browse files
committed
[DX-144] Sync Control API spec with latest Control API source
Brings static/open-specs/control-v1.yaml in line with the Control API implementation and its generated swagger document: - Add missing rule target fields: exchange (amqp/external), primarySite and provisionedCapacity (postgres outbox and mongodb ingress), watch (mongodb ingress), and status on amqp/external and Google Cloud Function create schemas - Add legacy webhook rule type to rule_response for batch-mode rules created before the http rule type was introduced - Add missing endpoints: GET /me/accounts and POST /help, with me_accounts, help_request and help_response schemas - Add inProgress and required fields to account and app stats responses - Fix namespace schemas: add missing type to conflationEnabled, correct batchingInterval description, mark batching and conflation fields nullable, and document that mutableMessages requires persisted - Mark key_response name nullable and align unsupported rule target with additionalProperties true - Point the docs page at the spec's new home in ably/docs
1 parent dc7e1f2 commit 5031308

2 files changed

Lines changed: 336 additions & 9 deletions

File tree

src/pages/docs/platform/account/control-api.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The Control API limits the number of requests per account and per access token p
3838

3939
## OpenAPI document <a id="open-api"/>
4040

41-
The OpenAPI document for this API can be found in the Ably OpenAPI Documents [GitHub repository](https://github.com/ably/open-specs). It is not required in order to use Control API, but is provided to you so you may optionally generate your own documentation in the tool of your choice, or use mocking tools such as [Prism](https://stoplight.io/open-source/prism/) to assist in developing your clients.
41+
The OpenAPI document for this API can be found in the Ably OpenAPI Documents [GitHub repository](https://github.com/ably/docs/tree/main/static/open-specs). It is not required in order to use Control API, but is provided to you so you may optionally generate your own documentation in the tool of your choice, or use mocking tools such as [Prism](https://stoplight.io/open-source/prism/) to assist in developing your clients.
4242

4343
In the [testing with Postman](#postman) section you learn how to import this OpenAPI document into Postman, to enable you to quickly try out Control API.
4444

@@ -797,7 +797,7 @@ A convenient way to try out the Control API is by importing the OpenAPI document
797797

798798
![Postman import dialog](../../../../images/content/screenshots/control-api/postman-import-dialog.png)
799799

800-
3. Click the **Link** tab, and paste in the following URL: `https://raw.githubusercontent.com/ably/open-specs/main/definitions/control-v1.yaml`, then click **Continue**:
800+
3. Click the **Link** tab, and paste in the following URL: `https://raw.githubusercontent.com/ably/docs/refs/heads/main/static/open-specs/control-v1.yaml`, then click **Continue**:
801801

802802
![Link to OpenAPI document](../../../../images/content/screenshots/control-api/postman-link.png)
803803

0 commit comments

Comments
 (0)