-
Notifications
You must be signed in to change notification settings - Fork 46
[DX-144] Update control API spec for missing fields #3257
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -4878,9 +4878,10 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz | |||||
| batchingInterval: | ||||||
| type: integer | ||||||
| default: 20 | ||||||
| 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). | ||||||
| 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. | ||||||
| example: 20 | ||||||
| conflationEnabled: | ||||||
| type: boolean | ||||||
| default: false | ||||||
| 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. | ||||||
| example: false | ||||||
|
|
@@ -4900,6 +4901,25 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz | |||||
| type: boolean | ||||||
| default: false | ||||||
| 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. | ||||||
| mutableMessages: | ||||||
| type: boolean | ||||||
| default: false | ||||||
| description: If `true`, messages received on a channel can be updated or deleted after publishing using message interactions. When `mutableMessages` is `true`, `persisted` must also be set to `true`. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| example: false | ||||||
| populateChannelRegistry: | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We shouldn't be exposing this property as it is for a feature that doesn't exist any longer. |
||||||
| type: boolean | ||||||
| default: false | ||||||
| description: If `true`, channels within this namespace will be populated in the channel registry, enabling enumeration of channels. | ||||||
| example: false | ||||||
| batchingPolicy: | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm assuming that |
||||||
| type: string | ||||||
| default: simple | ||||||
| description: The batching policy to use for channels within this namespace. | ||||||
| example: simple | ||||||
| batchingConflationKey: | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What's the difference between
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The Control API exposes |
||||||
| type: string | ||||||
| nullable: true | ||||||
| description: The conflation key used for batching. When set, messages with the same conflation key are merged during batching. | ||||||
| required: | ||||||
| - id | ||||||
| namespace_patch: | ||||||
|
|
@@ -4934,9 +4954,10 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz | |||||
| batchingInterval: | ||||||
| type: integer | ||||||
| default: 20 | ||||||
| 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). | ||||||
| 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. | ||||||
| example: 20 | ||||||
| conflationEnabled: | ||||||
| type: boolean | ||||||
| default: false | ||||||
| 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. | ||||||
| example: false | ||||||
|
|
@@ -4955,10 +4976,33 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz | |||||
| exposeTimeserial: | ||||||
| type: boolean | ||||||
| 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. | ||||||
| mutableMessages: | ||||||
| type: boolean | ||||||
| default: false | ||||||
| description: If `true`, messages received on a channel can be updated or deleted after publishing using message interactions. When `mutableMessages` is `true`, `persisted` must also be set to `true`. | ||||||
| example: false | ||||||
| populateChannelRegistry: | ||||||
| type: boolean | ||||||
| default: false | ||||||
| description: If `true`, channels within this namespace will be populated in the channel registry, enabling enumeration of channels. | ||||||
| example: false | ||||||
| batchingPolicy: | ||||||
| type: string | ||||||
| default: simple | ||||||
| description: The batching policy to use for channels within this namespace. | ||||||
| example: simple | ||||||
| batchingConflationKey: | ||||||
| type: string | ||||||
| nullable: true | ||||||
| description: The conflation key used for batching. When set, messages with the same conflation key are merged during batching. | ||||||
| namespace_response: | ||||||
| type: object | ||||||
| additionalProperties: false | ||||||
| properties: | ||||||
| appId: | ||||||
| type: string | ||||||
| description: The ID of the application that the namespace belongs to. | ||||||
| example: 28AB6c | ||||||
| authenticated: | ||||||
| type: boolean | ||||||
| default: false | ||||||
|
|
@@ -4999,9 +5043,10 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz | |||||
| batchingInterval: | ||||||
| type: integer | ||||||
| default: 20 | ||||||
| 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). | ||||||
| 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. | ||||||
| example: 20 | ||||||
| conflationEnabled: | ||||||
| type: boolean | ||||||
| default: false | ||||||
| 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. | ||||||
| example: false | ||||||
|
|
@@ -5020,6 +5065,25 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz | |||||
| exposeTimeserial: | ||||||
| type: boolean | ||||||
| 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. | ||||||
| mutableMessages: | ||||||
| type: boolean | ||||||
| default: false | ||||||
| description: If `true`, messages received on a channel can be updated or deleted after publishing using message interactions. When `mutableMessages` is `true`, `persisted` must also be set to `true`. | ||||||
| example: false | ||||||
| populateChannelRegistry: | ||||||
| type: boolean | ||||||
| default: false | ||||||
| description: If `true`, channels within this namespace will be populated in the channel registry, enabling enumeration of channels. | ||||||
| example: false | ||||||
| batchingPolicy: | ||||||
| type: string | ||||||
| default: simple | ||||||
| description: The batching policy to use for channels within this namespace. | ||||||
| example: simple | ||||||
| batchingConflationKey: | ||||||
| type: string | ||||||
| nullable: true | ||||||
| description: The conflation key used for batching. When set, messages with the same conflation key are merged during batching. | ||||||
| app_post: | ||||||
| type: object | ||||||
| additionalProperties: false | ||||||
|
|
@@ -5183,6 +5247,11 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz | |||||
| description: An array of strings setting the capability operations for the resource. | ||||||
| items: | ||||||
| type: string | ||||||
| revocableTokens: | ||||||
| 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. | ||||||
| type: boolean | ||||||
| default: false | ||||||
| example: false | ||||||
| example: | ||||||
| name: My key name | ||||||
| capability: | ||||||
|
|
@@ -5210,6 +5279,11 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz | |||||
| description: An array of strings setting the capability operations for the resource. | ||||||
| items: | ||||||
| type: string | ||||||
| revocableTokens: | ||||||
| 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. | ||||||
| type: boolean | ||||||
| default: false | ||||||
| example: false | ||||||
| example: | ||||||
| name: My key name | ||||||
| capability: | ||||||
|
|
@@ -5262,6 +5336,11 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz | |||||
| type: integer | ||||||
| description: Unix timestamp representing the date and time of the last modification of the key. | ||||||
| example: 1614679682091 | ||||||
| revocableTokens: | ||||||
| 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. | ||||||
| type: boolean | ||||||
| default: false | ||||||
| example: false | ||||||
| me: | ||||||
| type: object | ||||||
| additionalProperties: false | ||||||
|
|
||||||
Uh oh!
There was an error while loading. Please reload this page.