document new endpoint /broadcast/{broadcastTournamentId}/leaderboard

lichess-org · Mar 13, 2024 · cf3f460 · cf3f460
1 parent 9f85a94
commit cf3f460
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/doc/specs/lichess-api.yaml b/doc/specs/lichess-api.yaml
@@ -435,6 +435,9 @@ paths:
   /api/broadcast/{broadcastTournamentId}:
     $ref: './tags/broadcasts/broadcast-broadcastTournamentId.yaml'
 
+  /broadcast/{broadcastTournamentId}/leaderboard:
+    $ref: './tags/broadcasts/broadcast-broadcastTournamentId-leaderboard.yaml'
+
   /broadcast/{broadcastTournamentId}/edit:
     $ref: './tags/broadcasts/broadcast-broadcastTournamentId-edit.yaml'
 

diff --git a/doc/specs/tags/broadcasts/broadcast-broadcastTournamentId-leaderboard.yaml b/doc/specs/tags/broadcasts/broadcast-broadcastTournamentId-leaderboard.yaml
@@ -0,0 +1,17 @@
+get:
+  operationId: broadcastLeaderboardGet
+  summary: Get a broadcast leaderboard
+  description: |
+    Get the leaderboard of a broadcast tournament, if available.
+  tags:
+    - Broadcasts
+  parameters:
+    - in: path
+      name: broadcastTournamentId
+      description: The broadcast tournament ID (8 characters).
+      required: true
+      schema:
+        type: string
+  responses:
+    '200':
+      description: The broadcast leaderboard players