Skip to content

Commit b11de6d

Browse files
committed
Updated link to open-specs document and added missing fields for control api spec
1 parent d80e402 commit b11de6d

File tree

2 files changed

+123
-8
lines changed

2 files changed

+123
-8
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Note that the Control API has certain [limits](/docs/platform/pricing/limits#api
3636

3737
## OpenAPI document <a id="open-api"/>
3838

39-
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.
39+
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.
4040

4141
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.
4242

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

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

822-
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**:
822+
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**:
823823

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

static/open-specs/control-v1.yaml

Lines changed: 121 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4878,9 +4878,10 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz
48784878
batchingInterval:
48794879
type: integer
48804880
default: 20
4881-
description: If `true`, the batching interval, configurable from 20ms to 1s, temporarily holds and aggregates incoming messages. These messages are then combined and delivered as a single batch once the interval elapses or a size limit is reached (before the interval elapses).
4881+
description: The batching interval in milliseconds, configurable from 20ms to 1s. Temporarily holds and aggregates incoming messages, which are then combined and delivered as a single batch once the interval elapses or a size limit is reached.
48824882
example: 20
48834883
conflationEnabled:
4884+
type: boolean
48844885
default: false
48854886
description: If `true`, enables <a href="https://ably.com/docs/messages#conflation">conflation</a> for channels within this namespace. Conflation will aggregate published messages for a set period of time and evaluate them against a conflation key. Only the most recent message that satisfies the key will be sent to subscribers at the end of the conflation interval.
48864887
example: false
@@ -4896,10 +4897,41 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz
48964897
default: false
48974898
description: If `true`, only clients that are connected using TLS will be permitted to subscribe to any channels within this namespace.
48984899
example: false
4899-
exposeTimeserial:
4900+
exposeTimeSerial:
49004901
type: boolean
49014902
default: false
49024903
description: If `true`, messages received on a channel will contain a unique `timeserial` that can be referenced by later messages for use with message interactions.
4904+
mutableMessages:
4905+
type: boolean
4906+
default: false
4907+
description: If `true`, messages received on a channel can be updated or deleted after publishing using message interactions.
4908+
example: false
4909+
populateChannelRegistry:
4910+
type: boolean
4911+
default: false
4912+
description: If `true`, channels within this namespace will be populated in the channel registry, enabling enumeration of channels.
4913+
example: false
4914+
batchingPolicy:
4915+
type: string
4916+
default: simple
4917+
description: The batching policy to use for channels within this namespace.
4918+
example: simple
4919+
batchingConflationKey:
4920+
type: string
4921+
nullable: true
4922+
description: The conflation key used for batching. When set, messages with the same conflation key are merged during batching.
4923+
if:
4924+
properties:
4925+
mutableMessages:
4926+
const: true
4927+
required:
4928+
- mutableMessages
4929+
then:
4930+
properties:
4931+
persisted:
4932+
const: true
4933+
required:
4934+
- persisted
49034935
required:
49044936
- id
49054937
namespace_patch:
@@ -4934,9 +4966,10 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz
49344966
batchingInterval:
49354967
type: integer
49364968
default: 20
4937-
description: If `true`, the batching interval, configurable from 20ms to 1s, temporarily holds and aggregates incoming messages. These messages are then combined and delivered as a single batch once the interval elapses or a size limit is reached (before the interval elapses).
4969+
description: The batching interval in milliseconds, configurable from 20ms to 1s. Temporarily holds and aggregates incoming messages, which are then combined and delivered as a single batch once the interval elapses or a size limit is reached.
49384970
example: 20
49394971
conflationEnabled:
4972+
type: boolean
49404973
default: false
49414974
description: If `true`, enables <a href="https://ably.com/docs/messages#conflation">conflation</a> for channels within this namespace. Conflation will aggregate published messages for a set period of time and evaluate them against a conflation key. Only the most recent message that satisfies the key will be sent to subscribers at the end of the conflation interval.
49424975
example: false
@@ -4952,13 +4985,48 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz
49524985
default: false
49534986
description: If `true`, only clients that are connected using TLS will be permitted to subscribe to any channels within this namespace.
49544987
example: false
4955-
exposeTimeserial:
4988+
exposeTimeSerial:
49564989
type: boolean
49574990
description: If `true`, messages received on a channel will contain a unique `timeserial` that can be referenced by later messages for use with message interactions.
4991+
mutableMessages:
4992+
type: boolean
4993+
default: false
4994+
description: If `true`, messages received on a channel can be updated or deleted after publishing using message interactions.
4995+
example: false
4996+
populateChannelRegistry:
4997+
type: boolean
4998+
default: false
4999+
description: If `true`, channels within this namespace will be populated in the channel registry, enabling enumeration of channels.
5000+
example: false
5001+
batchingPolicy:
5002+
type: string
5003+
default: simple
5004+
description: The batching policy to use for channels within this namespace.
5005+
example: simple
5006+
batchingConflationKey:
5007+
type: string
5008+
nullable: true
5009+
description: The conflation key used for batching. When set, messages with the same conflation key are merged during batching.
5010+
if:
5011+
properties:
5012+
mutableMessages:
5013+
const: true
5014+
required:
5015+
- mutableMessages
5016+
then:
5017+
properties:
5018+
persisted:
5019+
const: true
5020+
required:
5021+
- persisted
49585022
namespace_response:
49595023
type: object
49605024
additionalProperties: false
49615025
properties:
5026+
appId:
5027+
type: string
5028+
description: The ID of the application that the namespace belongs to.
5029+
example: 28AB6c
49625030
authenticated:
49635031
type: boolean
49645032
default: false
@@ -4999,9 +5067,10 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz
49995067
batchingInterval:
50005068
type: integer
50015069
default: 20
5002-
description: If `true`, the batching interval, configurable from 20ms to 1s, temporarily holds and aggregates incoming messages. These messages are then combined and delivered as a single batch once the interval elapses or a size limit is reached (before the interval elapses).
5070+
description: The batching interval in milliseconds, configurable from 20ms to 1s. Temporarily holds and aggregates incoming messages, which are then combined and delivered as a single batch once the interval elapses or a size limit is reached.
50035071
example: 20
50045072
conflationEnabled:
5073+
type: boolean
50055074
default: false
50065075
description: If `true`, enables <a href="https://ably.com/docs/messages#conflation">conflation</a> for channels within this namespace. Conflation will aggregate published messages for a set period of time and evaluate them against a conflation key. Only the most recent message that satisfies the key will be sent to subscribers at the end of the conflation interval.
50075076
example: false
@@ -5017,9 +5086,40 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz
50175086
default: false
50185087
description: If `true`, only clients that are connected using TLS will be permitted to subscribe to any channels within this namespace.
50195088
example: false
5020-
exposeTimeserial:
5089+
exposeTimeSerial:
50215090
type: boolean
50225091
description: If `true`, messages received on a channel will contain a unique `timeserial` that can be referenced by later messages for use with message interactions.
5092+
mutableMessages:
5093+
type: boolean
5094+
default: false
5095+
description: If `true`, messages received on a channel can be updated or deleted after publishing using message interactions.
5096+
example: false
5097+
populateChannelRegistry:
5098+
type: boolean
5099+
default: false
5100+
description: If `true`, channels within this namespace will be populated in the channel registry, enabling enumeration of channels.
5101+
example: false
5102+
batchingPolicy:
5103+
type: string
5104+
default: simple
5105+
description: The batching policy to use for channels within this namespace.
5106+
example: simple
5107+
batchingConflationKey:
5108+
type: string
5109+
nullable: true
5110+
description: The conflation key used for batching. When set, messages with the same conflation key are merged during batching.
5111+
if:
5112+
properties:
5113+
mutableMessages:
5114+
const: true
5115+
required:
5116+
- mutableMessages
5117+
then:
5118+
properties:
5119+
persisted:
5120+
const: true
5121+
required:
5122+
- persisted
50235123
app_post:
50245124
type: object
50255125
additionalProperties: false
@@ -5183,6 +5283,11 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz
51835283
description: An array of strings setting the capability operations for the resource.
51845284
items:
51855285
type: string
5286+
revocableTokens:
5287+
description: If `true`, tokens issued by this key will be revocable. This enables the use of the token revocation API to invalidate tokens issued by this key.
5288+
type: boolean
5289+
default: false
5290+
example: false
51865291
example:
51875292
name: My key name
51885293
capability:
@@ -5210,6 +5315,11 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz
52105315
description: An array of strings setting the capability operations for the resource.
52115316
items:
52125317
type: string
5318+
revocableTokens:
5319+
description: If `true`, tokens issued by this key will be revocable. This enables the use of the token revocation API to invalidate tokens issued by this key.
5320+
type: boolean
5321+
default: false
5322+
example: false
52135323
example:
52145324
name: My key name
52155325
capability:
@@ -5262,6 +5372,11 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz
52625372
type: integer
52635373
description: Unix timestamp representing the date and time of the last modification of the key.
52645374
example: 1614679682091
5375+
revocableTokens:
5376+
description: If `true`, tokens issued by this key are revocable. This enables the use of the token revocation API to invalidate tokens issued by this key.
5377+
type: boolean
5378+
default: false
5379+
example: false
52655380
me:
52665381
type: object
52675382
additionalProperties: false

0 commit comments

Comments
 (0)