Skip to content
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

add more info in broadcast round #300

Merged
merged 1 commit into from
Jan 24, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions doc/specs/lichess-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4129,13 +4129,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:
Expand Down Expand Up @@ -4231,13 +4254,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:
Expand Down