Merge pull request #300 from SergioGlorias/patch-2

add more info in broadcast round
lichess-org · Jan 24, 2024 · 88f68f5 · 88f68f5
2 parents 872283a + 82a94d8
commit 88f68f5
Showing 1 changed file with 46 additions and 0 deletions.
diff --git a/doc/specs/lichess-api.yaml b/doc/specs/lichess-api.yaml
@@ -4167,13 +4167,36 @@ paths:
                     Example: `https://myserver.org/myevent/round-10/games.pgn`
 
                     If the syncUrl is missing, then the broadcast needs to be fed by [pushing PGN to it](#operation/broadcastPush).
+                syncUrlRound:
+                  type: string
+                  description: |
+                    Required if `syncUrl` contains a livechesscloud link.
                 startsAt:
                   type: integer
                   description: |
                     Timestamp in milliseconds of broadcast round start. Leave empty to manually start the broadcast round.
 
                     Example: `1356998400070`
                   minimum: 1356998400070
+                delay:
+                  type: integer
+                  description: |
+                    Delay in seconds for movements to appear on the broadcast. Leave it empty if you don't need it.
+
+                    Example: `900` (15 min)
+                  minimum: 0
+                  maximum: 1800
+                period:
+                  type: integer
+                  description: |
+                    (Only for Admins) Waiting time for each poll.
+                  minimum: 2
+                  maximum: 60
+                finished:
+                  type: boolean
+                  description: |
+                    Mark whether the round has been completed.
+                  default: false
               required:
                 - name
       responses:
@@ -4269,13 +4292,36 @@ paths:
                     URL that Lichess will poll to get updates about the games. It must be publicly accessible from the Internet.
 
                     Example: `https://myserver.org/myevent/round-10/games.pgn`
+                syncUrlRound:
+                  type: string
+                  description: |
+                    Required if `syncUrl` contains a livechesscloud link.
                 startsAt:
                   type: integer
                   description: |
                     Timestamp in milliseconds of broadcast start. Leave empty to manually start the broadcast.
 
                     Example: `1356998400070`
                   minimum: 1356998400070
+                delay:
+                  type: integer
+                  description: |
+                    Delay in seconds for movements to appear on the broadcast. Leave it empty if you don't need it.
+
+                    Example: `900` (15 min)
+                  minimum: 0
+                  maximum: 1800
+                period:
+                  type: integer
+                  description: |
+                    (Only for Admins) Waiting time for each poll.
+                  minimum: 2
+                  maximum: 60
+                finished:
+                  type: boolean
+                  description: |
+                    Mark whether the round has been completed.
+                  default: false
               required:
                 - name
       responses: