Skip to content

Commit

Permalink
Merge pull request #44 from ably/EDU-1582--Control-api-for-server-sid…
Browse files Browse the repository at this point in the history
…e-batching

EDU-1582: Updates control api for server-side batching
  • Loading branch information
m-hulbert authored Aug 5, 2024
2 parents 1273eda + 9a0ace9 commit 72958c3
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 1 deletion.
44 changes: 44 additions & 0 deletions definitions/control-v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4503,6 +4503,21 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz
default: false
description: If `true`, publishing messages with a push payload in the extras field is permitted and can trigger the delivery of a native push notification to registered devices for the channel.
example: false
batchingEnabled:
type: boolean
default: false
description: If `true`, channels within this namespace will start batching inbound messages instead of sending them out immediately to subscribers.
example: false
batchingPolicy:
type: string
default: simple
description: If `true`, groups multiple incoming messages into a single batch.
example: simple
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).
example: 20
tlsOnly:
type: boolean
default: false
Expand Down Expand Up @@ -4538,6 +4553,20 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz
default: false
description: If `true`, publishing messages with a push payload in the extras field is permitted and can trigger the delivery of a native push notification to registered devices for the channel.
example: false
batchingEnabled:
type: boolean
default: false
description: If `true`, channels within this namespace will start batching inbound messages instead of sending them out immediately to subscribers.
batchingPolicy:
type: string
default: simple
description: If `true`, groups multiple incoming messages into a single batch.
example: simple
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).
example: 20
tlsOnly:
type: boolean
default: false
Expand Down Expand Up @@ -4582,6 +4611,21 @@ TOfReTlUQzgpXRW5h3n2LVXbXQhPGcVitb88Cm2R8cxQwgB1VncM8yvmKhREo2tz
default: false
description: If `true`, publishing messages with a push payload in the extras field is permitted and can trigger the delivery of a native push notification to registered devices for the channel.
example: false
batchingEnabled:
type: boolean
default: false
description: If `true`, channels within this namespace will start batching inbound messages instead of sending them out immediately to subscribers.
example: false
batchingPolicy:
type: string
default: simple
description: If `true`, groups multiple incoming messages into a single batch.
example: simple
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).
example: 20
tlsOnly:
type: boolean
default: false
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 72958c3

Please sign in to comment.