Skip to content

Commit e9c9df7

Browse files
committed
document /api/broadcast?live=true
1 parent f45a528 commit e9c9df7

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

doc/specs/tags/broadcasts/api-broadcasts-official.yaml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ get:
22
operationId: broadcastsOfficial
33
summary: Get official broadcasts
44
description: |
5-
Returns ongoing official broadcasts sorted by tier.
5+
Returns active (a round is scheduled or ongoing) official broadcasts sorted by tier.
66
After that, returns finished broadcasts sorted by most recent sync time.
77
Broadcasts are streamed as [ndjson](#description/streaming-with-nd-json).
88
tags:
@@ -23,6 +23,13 @@ get:
2323
schema:
2424
type: boolean
2525
example: true
26+
- in: query
27+
name: live
28+
description: "[Filter] only broadcasts where a round is ongoing, i.e. started
29+
and not finished"
30+
schema:
31+
type: boolean
32+
example: true
2633
responses:
2734
"200":
2835
description: The list of official broadcasts.

0 commit comments

Comments
 (0)