Skip to content

Commit e4bb824

Browse files
committed
chore: update lichess api schema
1 parent 0fc90a5 commit e4bb824

15 files changed

Lines changed: 75 additions & 26 deletions

specs/lichess-api.yaml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: "3.1.0"
22
info:
3-
version: 2.0.139
3+
version: 2.0.143
44
title: Lichess.org API reference
55
contact:
66
name: "Lichess.org API"
@@ -219,7 +219,8 @@ tags:
219219
220220
Runs <https://github.com/lichess-org/lila-openingexplorer>.
221221
222-
**The endpoint hostname is not lichess.org but explorer.lichess.org.**
222+
> [!important]
223+
> The hostname for these endpoints is `explorer.lichess.org` and not `lichess.org`.
223224
- name: Puzzles
224225
description: |
225226
Fetch and solve [puzzles](https://lichess.org/training), view your puzzle history and dashboard.
@@ -241,7 +242,8 @@ tags:
241242
description: |
242243
Lookup positions from the [Lichess tablebase server](https://lichess.org/blog/W3WeMyQAACQAdfAL/7-piece-syzygy-tablebases-are-complete).
243244
244-
**The endpoint hostname is not lichess.org but tablebase.lichess.org.**
245+
> [!important]
246+
> The hostname for these endpoints is `tablebase.lichess.org` and not `lichess.org`.
245247
- name: Teams
246248
description: |
247249
Access and manage Lichess teams and their members.

specs/schemas/BroadcastGameEntry.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ properties:
2020
description: The change in rating for the player as a result of this game
2121
fideTC:
2222
$ref: "./FideTimeControl.yaml"
23+
ongoing:
24+
type: boolean
2325

2426
required:
2527
- round

specs/schemas/BroadcastTour.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ properties:
6262
description: "Full tournament description in markdown format, or in HTML if the html=1 query parameter is set."
6363
teamTable:
6464
type: boolean
65+
showTeamScores:
66+
type: boolean
6567
url:
6668
type: string
6769
format: uri

specs/schemas/PuzzleAndGame.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ properties:
7171
type: integer
7272
fen:
7373
type: string
74+
lastMove:
75+
type: string
76+
description: In UCI format, e.g. "e2e4"
7477
solution:
7578
type: array
7679
items:

specs/tags/externalengine/api-external-engine-id-analyse.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
servers:
2-
- url: https://engine.lichess.ovh
31
parameters:
42
- in: path
53
name: id
@@ -13,6 +11,12 @@ post:
1311
summary: Analyse with external engine
1412
tags:
1513
- External engine
14+
servers:
15+
- url: https://engine.lichess.ovh
16+
- url: http://localhost:{port}
17+
variables:
18+
port:
19+
default: "9666"
1620
security: []
1721
description: |
1822
**Endpoint: `https://engine.lichess.ovh/api/external-engine/{id}/analyse`**

specs/tags/externalengine/api-external-engine-work-id.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
servers:
2-
- url: https://engine.lichess.ovh
31
parameters:
42
- in: path
53
name: id
@@ -12,6 +10,12 @@ post:
1210
summary: Answer analysis request
1311
tags:
1412
- External engine
13+
servers:
14+
- url: https://engine.lichess.ovh
15+
- url: http://localhost:{port}
16+
variables:
17+
port:
18+
default: "9666"
1519
security: []
1620
description: |
1721
**Endpoint: `https://engine.lichess.ovh/api/external-engine/work/{id}`**

specs/tags/externalengine/api-external-engine-work.yaml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
1-
servers:
2-
- url: https://engine.lichess.ovh
31
post:
42
operationId: apiExternalEngineAcquire
53
summary: Acquire analysis request
64
tags:
75
- External engine
6+
servers:
7+
- url: https://engine.lichess.ovh
8+
- url: http://localhost:{port}
9+
variables:
10+
port:
11+
default: "9666"
812
security: []
913
description: |
1014
**Endpoint: `https://engine.lichess.ovh/api/external-engine/work`**
1115
Wait for an analysis requests to any of the external engines that
1216
have been registered with the given `secret`.
1317
Uses long polling.
1418
After acquiring a request, the provider should immediately
15-
[start streaming the results](#tag/external-engine/POST/api/external-engine/workid).
19+
[start streaming the results](#tag/external-engine/POST/api/external-engine/work/{id}).
1620
requestBody:
1721
description: Provider credentials.
1822
required: true

specs/tags/games/api-games-user-username.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,13 +185,13 @@ get:
185185
type: string
186186
default: "'*'"
187187
content:
188-
application/json:
188+
application/x-ndjson:
189189
schema:
190190
oneOf:
191191
- $ref: "../../schemas/GamePgn.yaml"
192192
- $ref: "../../schemas/GameJson.yaml"
193193
examples:
194194
application/x-chess-pgn:
195195
$ref: "../../examples/games-apiGamesUserPgn.pgn.yaml"
196-
application/json:
196+
application/x-ndjson:
197197
$ref: "../../examples/games-apiGamesUserJson.json.yaml"

specs/tags/openingexplorer/lichess.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
servers:
2-
- url: https://explorer.lichess.org
31
get:
42
operationId: openingExplorerLichess
53
summary: Lichess games
@@ -11,6 +9,12 @@ get:
119
Example: `curl https://explorer.lichess.org/lichess?variant=standard&speeds=blitz,rapid,classical&ratings=2200,2500&fen=rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR%20w%20KQkq%20-%200%201`
1210
tags:
1311
- Opening Explorer
12+
servers:
13+
- url: https://explorer.lichess.org
14+
- url: http://localhost:{port}
15+
variables:
16+
port:
17+
default: "9002"
1418
security:
1519
- OAuth2: []
1620
parameters:

specs/tags/openingexplorer/masters-pgn-gameId.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
servers:
2-
- url: https://explorer.lichess.org
31
get:
42
operationId: openingExplorerMasterGame
53
summary: OTB master game
@@ -9,6 +7,12 @@ get:
97
Example: `curl https://explorer.lichess.org/masters/pgn/aAbqI4ey`
108
tags:
119
- Opening Explorer
10+
servers:
11+
- url: https://explorer.lichess.org
12+
- url: http://localhost:{port}
13+
variables:
14+
port:
15+
default: "9002"
1216
security:
1317
- OAuth2: []
1418
parameters:

0 commit comments

Comments
 (0)