Skip to content

Commit 727c999

Browse files
committed
ci: update api
1 parent a9a0c25 commit 727c999

3 files changed

Lines changed: 14 additions & 3 deletions

File tree

specs/lichess-api.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: "3.1.0"
22
info:
3-
version: 2.0.138
3+
version: 2.0.139
44
title: Lichess.org API reference
55
contact:
66
name: "Lichess.org API"

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.

src/client/index.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2010,7 +2010,11 @@ export class Lichess {
20102010
/**
20112011
* Get official broadcasts
20122012
*/
2013-
async broadcastsOfficial(params: { nb?: number; html?: boolean }) {
2013+
async broadcastsOfficial(params: {
2014+
nb?: number;
2015+
html?: boolean;
2016+
live?: boolean;
2017+
}) {
20142018
const path = "/api/broadcast" as const;
20152019
return await this.requestor.get(
20162020
{ path, query: params },

0 commit comments

Comments
 (0)