From 9a0ace978719621b0cc7880e2d99f55da2df9254 Mon Sep 17 00:00:00 2001
From: Francis Roberts <111994975+franrob-projects@users.noreply.github.com>
Date: Mon, 1 Jul 2024 16:28:47 +0100
Subject: [PATCH] EDU-1582: Updates control api for server-side batching

---
 definitions/control-v1.yaml | 44 +++++++++++++++++++++++++++++++++++++
 package-lock.json           |  2 +-
 2 files changed, 45 insertions(+), 1 deletion(-)

diff --git a/definitions/control-v1.yaml b/definitions/control-v1.yaml
index 749d63d..83e9f29 100644
--- a/definitions/control-v1.yaml
+++ b/definitions/control-v1.yaml
@@ -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
@@ -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
@@ -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
diff --git a/package-lock.json b/package-lock.json
index bb24305..bc07741 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -544,4 +544,4 @@
       }
     }
   }
-}
\ No newline at end of file
+}