Skip to content

Commit ffdee2c

Browse files
github-actions[bot]CI
andauthored
ci: update api (#7)
Co-authored-by: CI <ci@rman.dev>
1 parent 92c1f8e commit ffdee2c

30 files changed

+54
-52
lines changed

specs/lichess-api.yaml

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: "3.1.0"
22
info:
3-
version: 2.0.112
3+
version: 2.0.113
44
title: Lichess.org API reference
55
contact:
66
name: "Lichess.org API"
@@ -117,11 +117,11 @@ tags:
117117
Works with normal Lichess accounts. Engine play or assistance is [forbidden](https://lichess.org/page/fair-play).
118118
119119
### Features
120-
- [Stream incoming chess moves](#tag/board/get/apiboardgamestreamgameid)
121-
- [Play chess moves](#tag/board/post/apiboardgamegameidmovemove)
122-
- [Read](#tag/board/get/apiboardgamestreamgameid) and [write](#tag/board/post/apiboardgamegameidchat) in the player and spectator chats
123-
- [Receive](#tag/board/get/apistreamevent), [create](#tag/challenges/post/apichallengeusername) and [accept](#tag/challenges/post/apichallengechallengeidaccept) (or [decline](#tag/challenges/post/apichallengechallengeiddecline)) challenges
124-
- [Abort](#tag/board/post/apiboardgamegameidabort) and [resign](#tag/board/post/apiboardgamegameidresign) games
120+
- [Stream incoming chess moves](#tag/board/GET/api/board/game/stream/{gameId})
121+
- [Play chess moves](#tag/board/POST/api/board/game/{gameId}/move/{move})
122+
- [Read](#tag/board/GET/api/board/game/stream/{gameId}) and [write](#tag/board/POST/api/board/game/{gameId}/chat) in the player and spectator chats
123+
- [Receive](#tag/board/GET/api/stream/event), [create](#tag/challenges/POST/api/challenge/{username}) and [accept](#tag/challenges/POST/api/challenge/{challengeId}/accept) (or [decline](#tag/challenges/POST/api/challenge/{challengeId}/decline)) challenges
124+
- [Abort](#tag/board/POST/api/board/game/{gameId}/abort) and [resign](#tag/board/POST/api/board/game/{gameId}/resign) games
125125
- Compatible with normal Lichess accounts
126126
127127
### Restrictions
@@ -136,19 +136,21 @@ tags:
136136
- [Lichs (play from command-line)](https://github.com/Cqsi/lichs)
137137
- [Lichess discord bot](https://top.gg/bot/707287095911120968)
138138
- [cli-chess](https://github.com/trevorbayless/cli-chess/)
139+
- [Blunderly 3D board](https://github.com/maurimo/blunderly)
140+
- Yours? Please make [an issue or pull request](https://github.com/lichess-org/api).
139141
- name: Bot
140142
description: |
141143
Play on Lichess as a bot. Allows engine play.
142144
Read the [blog post announcement of lichess bots](https://lichess.org/blog/WvDNticAAMu_mHKP/welcome-lichess-bots).
143145
144-
Only works with [Bot accounts](#tag/bot/post/apibotaccountupgrade).
146+
Only works with [Bot accounts](#tag/bot/POST/api/bot/account/upgrade).
145147
146148
### Features
147-
- [Stream incoming chess moves](#tag/bot/get/apibotgamestreamgameid)
148-
- [Play chess moves](#tag/bot/post/apibotgamegameidmovemove)
149-
- [Read](#tag/bot/get/apibotgamestreamgameid) and [write](#tag/bot/post/apibotgamegameidchat) in the player and spectator chats
150-
- [Receive](#tag/bot/get/apistreamevent), [create](#tag/challenges/post/apichallengeusername) and [accept](#tag/challenges/post/apichallengechallengeidaccept) (or [decline](#tag/challenges/post/apichallengechallengeiddecline)) challenges
151-
- [Abort](#tag/bot/post/apibotgamegameidabort) and [resign](#tag/bot/post/apibotgamegameidresign) games
149+
- [Stream incoming chess moves](#tag/bot/GET/api/bot/game/stream/{gameId})
150+
- [Play chess moves](#tag/bot/POST/api/bot/game/{gameId}/move/{move})
151+
- [Read](#tag/bot/GET/api/bot/game/stream/{gameId}) and [write](#tag/bot/POST/api/bot/game/{gameId}/chat) in the player and spectator chats
152+
- [Receive](#tag/bot/GET/api/stream/event), [create](#tag/challenges/POST/api/challenge/{username}) and [accept](#tag/challenges/POST/api/challenge/{challengeId}/accept) (or [decline](#tag/challenges/POST/api/challenge/{challengeId}/decline)) challenges
153+
- [Abort](#tag/bot/POST/api/bot/game/{gameId}/abort) and [resign](#tag/bot/POST/api/bot/game/{gameId}/resign) games
152154
- Engine assistance is [allowed](https://lichess.org/page/fair-play)
153155
### Restrictions
154156
- Bots can only play challenge games: pools and tournaments are off-limits
@@ -173,7 +175,7 @@ tags:
173175
[Official broadcasts](https://lichess.org/broadcast) are maintained by Lichess,
174176
but you can [create your own broadcasts](https://lichess.org/broadcast/new) to cover any live game or chess event.
175177
You will need to publish PGN on a public URL so that Lichess can pull updates from it.
176-
Alternatively, you can push PGN updates to Lichess using [this API endpoint](#tag/Broadcasts/operation/broadcastPush).
178+
Alternatively, you can push PGN updates to Lichess using [this API endpoint](#tag/broadcasts/POST/api/broadcast/round/{broadcastRoundId}/push).
177179
178180
Broadcasts are organized in tournaments, which have several rounds, which have several games.
179181
You must first create a tournament, then you can add rounds to them.
@@ -186,7 +188,7 @@ tags:
186188
description: |
187189
Send and receive challenges to play.
188190
189-
To create a lot of challenges, consider [bulk pairing](#tag/bulk-pairings/post/apibulk-pairing) instead.
191+
To create a lot of challenges, consider [bulk pairing](#tag/bulk-pairings/POST/api/bulk-pairing) instead.
190192
- name: External engine
191193
description: |
192194
**This API is in alpha and subject to change.**
@@ -775,7 +777,7 @@ components:
775777
OAuth2:
776778
type: oauth2
777779
description: |
778-
Read [the introduction for how to make authenticated requests](/#description/authentication).
780+
Read [the introduction for how to make authenticated requests](#description/authentication).
779781
flows:
780782
authorizationCode:
781783
authorizationUrl: https://lichess.org/oauth
@@ -802,5 +804,5 @@ components:
802804
"follow:write": Follow and unfollow other players
803805
"msg:write": Send private messages to other players
804806
"board:play": Play with the Board API
805-
"bot:play": Play with the Bot API. Only for [Bot accounts](#tag/bot/post/apibotaccountupgrade)
807+
"bot:play": Play with the Bot API. Only for [Bot accounts](#tag/bot/POST/api/bot/account/upgrade)
806808
"web:mod": Use moderator tools (within the bounds of your permissions)

specs/schemas/ExternalEngine.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ properties:
1212
type: string
1313
description: |
1414
A secret token that can be used to
15-
[*request* analysis](#tag/External-engine/operation/apiExternalEngineAnalyse)
15+
[*request* analysis](#tag/external-engine/POST/api/external-engine/{id}/analyse)
1616
from this external engine.
1717
userId:
1818
type: string

specs/schemas/ExternalEngineRegistration.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ properties:
3333
type: string
3434
description: |
3535
A random token that can be used to
36-
[wait for analysis requests](#tag/External-engine/operation/apiExternalEngineAcquire)
36+
[wait for analysis requests](#tag/external-engine/POST/api/external-engine/work)
3737
and provide analysis.
3838
3939
The engine provider should securely generate a random string.

specs/schemas/UserExtended.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ allOf:
1717
$ref: "./UserStreamer.yaml"
1818
followable:
1919
type: boolean
20-
description: only appears if the request is [authenticated with OAuth2](/#description/authentication)
20+
description: only appears if the request is [authenticated with OAuth2](#description/authentication)
2121
following:
2222
type: boolean
23-
description: only appears if the request is [authenticated with OAuth2](/#description/authentication)
23+
description: only appears if the request is [authenticated with OAuth2](#description/authentication)
2424
blocking:
2525
type: boolean
26-
description: only appears if the request is [authenticated with OAuth2](/#description/authentication)
26+
description: only appears if the request is [authenticated with OAuth2](#description/authentication)
2727
required:
2828
- url

specs/tags/arenatournaments/api-tournament-id-games.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ get:
66
Games are sorted by reverse chronological order (most recent first).
77
The game stream is throttled, depending on who is making the request:
88
- Anonymous request: 20 games per second
9-
- [OAuth2 authenticated](/#description/authentication) request: 30 games per second
9+
- [OAuth2 authenticated](#description/authentication) request: 30 games per second
1010
tags:
1111
- "Tournaments (Arena)"
1212
security: []

specs/tags/arenatournaments/api-tournament-id-join.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ post:
33
summary: Join an Arena tournament
44
description: |
55
Join an Arena tournament, possibly with a password and/or a team.
6-
Also unpauses if you had previously [paused](#tag/arena-tournaments/post/apitournamentidwithdraw) the tournament.
6+
Also unpauses if you had previously [paused](#tag/arena-tournaments/POST/api/tournament/{id}/withdraw) the tournament.
77
tags:
88
- "Tournaments (Arena)"
99
security:

specs/tags/arenatournaments/api-tournament-team-battle-id.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ post:
33
summary: Update a team battle
44
description: |
55
Set the teams and number of leaders of a team battle.
6-
To update the other attributes of a team battle, use the [tournament update endpoint](#tag/arena-tournaments/post/apitournamentid).
6+
To update the other attributes of a team battle, use the [tournament update endpoint](#tag/arena-tournaments/POST/api/tournament/{id}).
77
tags:
88
- "Tournaments (Arena)"
99
security:

specs/tags/arenatournaments/api-tournament.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ post:
163163
type: string
164164
description: |
165165
Set the ID of a team you lead to create a team battle.
166-
The other teams can be added using the [team battle edit endpoint](#tag/arena-tournaments/post/apitournamentteam-battleid).
166+
The other teams can be added using the [team battle edit endpoint](#tag/arena-tournaments/POST/api/tournament/team-battle/{id}).
167167
conditions.teamMember.teamId:
168168
type: string
169169
description: |

specs/tags/arenatournaments/api-user-username-tournament-created.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ get:
77
Tournaments are streamed as [ndjson](#description/streaming-with-nd-json).
88
The stream is throttled, depending on who is making the request:
99
- Anonymous request: 20 tournaments per second
10-
- [OAuth2 authenticated](/#description/authentication) request: 30 tournaments per second
10+
- [OAuth2 authenticated](#description/authentication) request: 30 tournaments per second
1111
- Authenticated, downloading your own tournaments: 50 tournaments per second
1212
tags:
1313
- "Tournaments (Arena)"

specs/tags/arenatournaments/api-user-username-tournament-played.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ get:
77
Tournaments are streamed as [ndjson](#description/streaming-with-nd-json).
88
The stream is throttled, depending on who is making the request:
99
- Anonymous request: 20 tournaments per second
10-
- [OAuth2 authenticated](/#description/authentication) request: 30 tournaments per second
10+
- [OAuth2 authenticated](#description/authentication) request: 30 tournaments per second
1111
- Authenticated, downloading your own tournaments: 50 tournaments per second
1212
tags:
1313
- "Tournaments (Arena)"

0 commit comments

Comments
 (0)