ci: update api (#12)

github-actions[bot] · x-roman · web-flow · commit 079bf0a2d6d8 · 2026-02-14T22:30:04.000Z
Co-authored-by: CI &lt;ci@rman.dev&gt;
diff --git a/specs/lichess-api.yaml b/specs/lichess-api.yaml
@@ -1,6 +1,6 @@
 openapi: "3.1.0"
 info:
-  version: 2.0.116
+  version: 2.0.119
   title: Lichess.org API reference
   contact:
     name: "Lichess.org API"
@@ -500,6 +500,9 @@ paths:
   /broadcast/{broadcastTournamentId}/players/{playerId}:
     $ref: "./tags/broadcasts/broadcast-broadcastTournamentId-players-playerId.yaml"
 
+  /broadcast/{broadcastTournamentId}/teams/standings:
+    $ref: "./tags/broadcasts/broadcast-broadcastTournamentId-teams-standings.yaml"
+
   /broadcast/{broadcastTournamentId}/edit:
     $ref: "./tags/broadcasts/broadcast-broadcastTournamentId-edit.yaml"
 
diff --git a/specs/schemas/BroadcastForm.yaml b/specs/schemas/BroadcastForm.yaml
@@ -25,7 +25,7 @@ properties:
     description: |
       Time control.
       Example: `"Classical" or "Rapid" or "Rapid & Blitz"`
-  info.fideTc:
+  info.fideTC:
     $ref: "./FideTimeControl.yaml"
   info.timeZone:
     type: string
diff --git a/specs/schemas/BroadcastGameEntry.yaml b/specs/schemas/BroadcastGameEntry.yaml
@@ -12,11 +12,7 @@ properties:
   color:
     $ref: "./GameColor.yaml"
   points:
-    type: string
-    enum:
-      - "1"
-      - "1/2"
-      - "0"
+    $ref: "./BroadcastPointStr.yaml"
   customPoints:
     $ref: "./BroadcastCustomPoints.yaml"
   ratingDiff:
diff --git a/specs/schemas/BroadcastPlayerEntry.yaml b/specs/schemas/BroadcastPlayerEntry.yaml
@@ -11,9 +11,34 @@ allOf:
       ratingDiff:
         type: integer
         example: -5
+        deprecated: true
+      ratingDiffs:
+        description: |
+          Rating differences by FIDE time control.
+        allOf:
+          - $ref: "./StatByFideTC.yaml"
+        example:
+          rapid: -5
+          blitz: 10
+      ratingsMap:
+        description: |
+          Player's ratings at the time of the tournament.
+        allOf:
+          - $ref: "./StatByFideTC.yaml"
+        example:
+          rapid: 2500
+          blitz: 2450
       performance:
         type: integer
         example: 2138
+        deprecated: true
+      performances:
+        description: |
+          Performance ratings by FIDE time control.
+        allOf:
+          - $ref: "./StatByFideTC.yaml"
+        example:
+          standard: 2138
       tiebreaks:
         type: array
         maxItems: 5
diff --git a/specs/schemas/BroadcastPlayerEntryWithFideAndGames.yaml b/specs/schemas/BroadcastPlayerEntryWithFideAndGames.yaml
@@ -9,14 +9,9 @@ allOf:
             type: integer
             description: Year of birth
           ratings:
-            type: object
-            properties:
-              standard:
-                type: integer
-              rapid:
-                type: integer
-              blitz:
-                type: integer
+            description: Player's current ratings from the latest FIDE rating list.
+            allOf:
+              - $ref: "./StatByFideTC.yaml"
       games:
         type: array
         description: List of games played by the player in the broadcast tournament
diff --git a/specs/schemas/BroadcastPointStr.yaml b/specs/schemas/BroadcastPointStr.yaml
@@ -0,0 +1,5 @@
+type: string
+enum:
+  - "1"
+  - "1/2"
+  - "0"
diff --git a/specs/schemas/BroadcastTeamLeaderboardEntry.yaml b/specs/schemas/BroadcastTeamLeaderboardEntry.yaml
@@ -0,0 +1,28 @@
+properties:
+  name:
+    type: string
+    description: "The name of the team"
+  mp:
+    type: number
+    description: "Total match points scored"
+  gp:
+    type: number
+    description: "Total game points scored"
+  averageRating:
+    type: integer
+    description: "The average rating of the team's players"
+  matches:
+    type: array
+    items:
+      $ref: "./BroadcastTeamPOVMatchEntry.yaml"
+  players:
+    type: array
+    description: "Players who have played for the team and their overall score"
+    items:
+      $ref: "./BroadcastPlayerEntry.yaml"
+required:
+  - name
+  - mp
+  - gp
+  - matches
+  - players
diff --git a/specs/schemas/BroadcastTeamPOVMatchEntry.yaml b/specs/schemas/BroadcastTeamPOVMatchEntry.yaml
@@ -0,0 +1,18 @@
+type: object
+properties:
+  roundId:
+    type: string
+  opponent:
+    type: string
+    description: "The name of the opposing team"
+  mp:
+    type: number
+    description: "Match points scored in this match"
+  gp:
+    type: number
+    description: "Game points scored in this match"
+  points:
+    $ref: "./BroadcastPointStr.yaml"
+required:
+  - roundId
+  - opponent
diff --git a/specs/schemas/BroadcastTour.yaml b/specs/schemas/BroadcastTour.yaml
@@ -36,10 +36,9 @@ properties:
       tc:
         type: string
         description: "Time control"
-      fideTc:
-        type: string
-        enum: [standard, rapid, blitz]
+      fideTC:
         description: "FIDE rating category"
+        $ref: "./FideTimeControl.yaml"
       timeZone:
         type: string
         description: |
@@ -61,8 +60,6 @@ properties:
   description:
     type: string
     description: "Full tournament description in markdown format, or in HTML if the html=1 query parameter is set."
-  leaderboard:
-    type: boolean
   teamTable:
     type: boolean
   url:
diff --git a/specs/schemas/StatByFideTC.yaml b/specs/schemas/StatByFideTC.yaml
@@ -0,0 +1,8 @@
+type: object
+properties:
+  standard:
+    type: integer
+  rapid:
+    type: integer
+  blitz:
+    type: integer
diff --git a/specs/schemas/TablebaseJson.yaml b/specs/schemas/TablebaseJson.yaml
@@ -50,7 +50,7 @@ properties:
     type: ["null", "integer"]
     description: |
       Depth To Mate: Plies to mate (available only for Standard positions
-      with not more than 5 pieces)
+      with not more than 6 pieces)
   dtw:
     type: ["null", "integer"]
     description: |
diff --git a/specs/tags/broadcasts/broadcast-broadcastTournamentId-teams-standings.yaml b/specs/tags/broadcasts/broadcast-broadcastTournamentId-teams-standings.yaml
@@ -0,0 +1,28 @@
+get:
+  operationId: broadcastTeamLeaderboardGet
+  summary: Get the team leaderboard of a broadcast
+  description: |
+    Get the team leaderboard of a broadcast tournament, if available.
+  tags:
+    - Broadcasts
+  security: []
+  parameters:
+    - in: path
+      name: broadcastTournamentId
+      description: The broadcast tournament ID
+      required: true
+      schema:
+        type: string
+        minLength: 8
+        maxLength: 8
+  responses:
+    "200":
+      description: The team leaderboard
+      content:
+        application/json:
+          schema:
+            type: array
+            items:
+              $ref: "../../schemas/BroadcastTeamLeaderboardEntry.yaml"
+    "404":
+      description: Broadcast tournament not found
diff --git a/src/client/index.ts b/src/client/index.ts
@@ -2667,6 +2667,29 @@ export class Lichess {
     }
   }
 
+  /**
+   * Get the team leaderboard of a broadcast
+   */
+  async broadcastTeamLeaderboardGet(params: { broadcastTournamentId: string }) {
+    const path =
+      `/broadcast/${params.broadcastTournamentId}/teams/standings` as const;
+    const { response, status } = await this.requestor.get({ path });
+    switch (status) {
+      case 200: {
+        const schema = z.array(schemas.BroadcastTeamLeaderboardEntry);
+        const json: unknown = await response.clone().json();
+        const data = schema.parse(json);
+        return { status, response, data } as const;
+      }
+      case 404: {
+        return { status, response } as const;
+      }
+      default: {
+        throw new Error("Unexpected status code");
+      }
+    }
+  }
+
   /**
    * Update your broadcast tournament
    */
diff --git a/src/schemas/BroadcastForm.ts b/src/schemas/BroadcastForm.ts
@@ -8,7 +8,7 @@ const BroadcastForm = z.object({
   "info.format": z.optional(z.string().check(z.maxLength(80))),
   "info.location": z.optional(z.string().check(z.maxLength(80))),
   "info.tc": z.optional(z.string().check(z.maxLength(80))),
-  "info.fideTc": z.optional(FideTimeControl),
+  "info.fideTC": z.optional(FideTimeControl),
   "info.timeZone": z.optional(z.string()),
   "info.players": z.optional(z.string().check(z.maxLength(120))),
   "info.website": z.optional(z.url()),
diff --git a/src/schemas/BroadcastGameEntry.ts b/src/schemas/BroadcastGameEntry.ts
@@ -2,6 +2,7 @@ import * as z from "zod/mini";
 
 import { BroadcastCustomPoints } from "./BroadcastCustomPoints";
 import { BroadcastPlayerWithFed } from "./BroadcastPlayerWithFed";
+import { BroadcastPointStr } from "./BroadcastPointStr";
 import { FideTimeControl } from "./FideTimeControl";
 import { GameColor } from "./GameColor";
 
@@ -10,7 +11,7 @@ const BroadcastGameEntry = z.object({
   id: z.string(),
   opponent: BroadcastPlayerWithFed,
   color: GameColor,
-  points: z.optional(z.literal(["1", "1/2", "0"])),
+  points: z.optional(BroadcastPointStr),
   customPoints: z.optional(BroadcastCustomPoints),
   ratingDiff: z.optional(z.int()),
   fideTC: z.optional(FideTimeControl),
diff --git a/src/schemas/BroadcastPlayerEntry.ts b/src/schemas/BroadcastPlayerEntry.ts
@@ -2,14 +2,18 @@ import * as z from "zod/mini";
 
 import { BroadcastPlayerTiebreak } from "./BroadcastPlayerTiebreak";
 import { BroadcastPlayerWithFed } from "./BroadcastPlayerWithFed";
+import { StatByFideTC } from "./StatByFideTC";
 
 const BroadcastPlayerEntry = z.intersection(
   BroadcastPlayerWithFed,
   z.object({
     score: z.optional(z.number()),
     played: z.optional(z.int()),
     ratingDiff: z.optional(z.int()),
+    ratingDiffs: z.optional(StatByFideTC),
+    ratingsMap: z.optional(StatByFideTC),
     performance: z.optional(z.int()),
+    performances: z.optional(StatByFideTC),
     tiebreaks: z.optional(
       z.array(BroadcastPlayerTiebreak).check(z.maxLength(5)),
     ),
diff --git a/src/schemas/BroadcastPlayerEntryWithFideAndGames.ts b/src/schemas/BroadcastPlayerEntryWithFideAndGames.ts
@@ -2,20 +2,15 @@ import * as z from "zod/mini";
 
 import { BroadcastGameEntry } from "./BroadcastGameEntry";
 import { BroadcastPlayerEntry } from "./BroadcastPlayerEntry";
+import { StatByFideTC } from "./StatByFideTC";
 
 const BroadcastPlayerEntryWithFideAndGames = z.intersection(
   BroadcastPlayerEntry,
   z.object({
     fide: z.optional(
       z.object({
         year: z.optional(z.int()),
-        ratings: z.optional(
-          z.object({
-            standard: z.optional(z.int()),
-            rapid: z.optional(z.int()),
-            blitz: z.optional(z.int()),
-          }),
-        ),
+        ratings: z.optional(StatByFideTC),
       }),
     ),
     games: z.optional(z.array(BroadcastGameEntry)),
diff --git a/src/schemas/BroadcastPointStr.ts b/src/schemas/BroadcastPointStr.ts
@@ -0,0 +1,7 @@
+import * as z from "zod/mini";
+
+const BroadcastPointStr = z.literal(["1", "1/2", "0"]);
+
+type BroadcastPointStr = z.infer<typeof BroadcastPointStr>;
+
+export { BroadcastPointStr };
diff --git a/src/schemas/BroadcastTeamLeaderboardEntry.ts b/src/schemas/BroadcastTeamLeaderboardEntry.ts
@@ -0,0 +1,19 @@
+import * as z from "zod/mini";
+
+import { BroadcastPlayerEntry } from "./BroadcastPlayerEntry";
+import { BroadcastTeamPOVMatchEntry } from "./BroadcastTeamPOVMatchEntry";
+
+const BroadcastTeamLeaderboardEntry = z.object({
+  name: z.string(),
+  mp: z.number(),
+  gp: z.number(),
+  averageRating: z.optional(z.int()),
+  matches: z.array(BroadcastTeamPOVMatchEntry),
+  players: z.array(BroadcastPlayerEntry),
+});
+
+type BroadcastTeamLeaderboardEntry = z.infer<
+  typeof BroadcastTeamLeaderboardEntry
+>;
+
+export { BroadcastTeamLeaderboardEntry };
diff --git a/src/schemas/BroadcastTeamPOVMatchEntry.ts b/src/schemas/BroadcastTeamPOVMatchEntry.ts
@@ -0,0 +1,15 @@
+import * as z from "zod/mini";
+
+import { BroadcastPointStr } from "./BroadcastPointStr";
+
+const BroadcastTeamPOVMatchEntry = z.object({
+  roundId: z.string(),
+  opponent: z.string(),
+  mp: z.optional(z.number()),
+  gp: z.optional(z.number()),
+  points: z.optional(BroadcastPointStr),
+});
+
+type BroadcastTeamPOVMatchEntry = z.infer<typeof BroadcastTeamPOVMatchEntry>;
+
+export { BroadcastTeamPOVMatchEntry };
diff --git a/src/schemas/BroadcastTour.ts b/src/schemas/BroadcastTour.ts
@@ -1,5 +1,6 @@
 import * as z from "zod/mini";
 
+import { FideTimeControl } from "./FideTimeControl";
 import { LightUser } from "./LightUser";
 
 const BroadcastTour = z.object({
@@ -16,7 +17,7 @@ const BroadcastTour = z.object({
       players: z.optional(z.string()),
       location: z.optional(z.string()),
       tc: z.optional(z.string()),
-      fideTc: z.optional(z.literal(["standard", "rapid", "blitz"])),
+      fideTC: z.optional(FideTimeControl),
       timeZone: z.optional(z.string()),
       standings: z.optional(z.url()),
       format: z.optional(z.string()),
@@ -25,7 +26,6 @@ const BroadcastTour = z.object({
   tier: z.optional(z.int()),
   image: z.optional(z.url()),
   description: z.optional(z.string()),
-  leaderboard: z.optional(z.boolean()),
   teamTable: z.optional(z.boolean()),
   url: z.url(),
   communityOwner: z.optional(LightUser),
diff --git a/src/schemas/StatByFideTC.ts b/src/schemas/StatByFideTC.ts
@@ -0,0 +1,11 @@
+import * as z from "zod/mini";
+
+const StatByFideTC = z.object({
+  standard: z.optional(z.int()),
+  rapid: z.optional(z.int()),
+  blitz: z.optional(z.int()),
+});
+
+type StatByFideTC = z.infer<typeof StatByFideTC>;
+
+export { StatByFideTC };
diff --git a/src/schemas/index.ts b/src/schemas/index.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +type: string
 +enum:
 +  - "1"
 +  - "1/2"
 +  - "0"