You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/pages/docs/platform/account/control-api.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ Note that the Control API has certain [limits](/docs/platform/pricing/limits#api
36
36
37
37
## OpenAPI document <aid="open-api"/>
38
38
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.
40
40
41
41
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.
42
42
@@ -819,7 +819,7 @@ A convenient way to try out the Control API is by importing the OpenAPI document
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**:
823
823
824
824

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.
4882
4882
example: 20
4883
4883
conflationEnabled:
4884
+
type: boolean
4884
4885
default: false
4885
4886
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.
description: If `true`, only clients that are connected using TLS will be permitted to subscribe to any channels within this namespace.
4898
4899
example: false
4899
-
exposeTimeserial:
4900
+
exposeTimeSerial:
4900
4901
type: boolean
4901
4902
default: false
4902
4903
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.
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.
4938
4970
example: 20
4939
4971
conflationEnabled:
4972
+
type: boolean
4940
4973
default: false
4941
4974
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.
description: If `true`, only clients that are connected using TLS will be permitted to subscribe to any channels within this namespace.
4954
4987
example: false
4955
-
exposeTimeserial:
4988
+
exposeTimeSerial:
4956
4989
type: boolean
4957
4990
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
4958
5022
namespace_response:
4959
5023
type: object
4960
5024
additionalProperties: false
4961
5025
properties:
5026
+
appId:
5027
+
type: string
5028
+
description: The ID of the application that the namespace belongs to.
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.
5003
5071
example: 20
5004
5072
conflationEnabled:
5073
+
type: boolean
5005
5074
default: false
5006
5075
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.
description: If `true`, only clients that are connected using TLS will be permitted to subscribe to any channels within this namespace.
5019
5088
example: false
5020
-
exposeTimeserial:
5089
+
exposeTimeSerial:
5021
5090
type: boolean
5022
5091
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.
description: An array of strings setting the capability operations for the resource.
5184
5284
items:
5185
5285
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.
description: An array of strings setting the capability operations for the resource.
5211
5316
items:
5212
5317
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.
description: Unix timestamp representing the date and time of the last modification of the key.
5264
5374
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.
0 commit comments