diff --git a/doc/specs/lichess-api.yaml b/doc/specs/lichess-api.yaml index eca8d1ac..21be62eb 100644 --- a/doc/specs/lichess-api.yaml +++ b/doc/specs/lichess-api.yaml @@ -106,37 +106,10 @@ tags: description: | Read and write account information and preferences. - - name: Users - description: | - Access registered users on Lichess. - - - - Each user blog exposes an atom (RSS) feed, like - - User blogs mashup feed: https://lichess.org/blog/community.atom - - User blogs mashup feed for a language: https://lichess.org/blog/community/fr.atom - - - name: Relations - description: | - Access relations between users. - - name: Games - description: | - Access games played on Lichess. - - - name: TV - description: | - Access Lichess TV channels and games. - & - - name: Puzzles - description: | - Access Lichess [puzzle history and dashboard](https://lichess.org/training). - - Our collection of puzzles is in the public domain, you can [download it here](https://database.lichess.org/#puzzles). - For a list of our puzzle themes with their description, check out the [theme translation file](https://github.com/ornicar/lila/blob/master/translation/source/puzzleTheme.xml). - The daily puzzle can be [posted in your slack workspace](https://lichess.org/daily-puzzle-slack). - - name: Teams + - name: Analysis description: | - Access and manage Lichess teams and their members. - + Access Lichess cloud evaluations database. + - name: Board description: | Play on Lichess with physical boards and third-party clients. @@ -193,37 +166,6 @@ tags: - Join the [Lichess Bots team](https://lichess.org/team/lichess-bots) with your bot account - [Get help in the discord channel](https://discord.gg/quwueFd) - Watch [Lichess Bot TV](https://lichess.org/tv/bot) - - name: Challenges - description: | - Send and receive challenges to play. - - To create a lot of challenges, consider [bulk pairing](#tag/bulk-pairings/post/apibulk-pairing) instead. - - name: Bulk pairings - description: | - Create many games for other players. - - These endpoints are intended for tournament organisers. - - name: Arena tournaments - description: | - Access Arena tournaments played on Lichess. - [Official Arena tournaments](https://lichess.org/tournament) are maintained by Lichess, - but you can [create your own Arena tournaments](https://lichess.org/tournament/new) as well. - - name: Swiss tournaments - description: | - Access Swiss tournaments played on Lichess. - [Read more about Swiss tournaments.](https://lichess.org/swiss). - - name: Simuls - description: | - Access simuls played on Lichess. - - - name: Studies - description: | - Access Lichess studies. - - - name: Messaging - description: | - Private messages with other players. - - name: Broadcasts description: | Relay chess events on Lichess. @@ -234,15 +176,16 @@ tags: Broadcasts are organized in tournaments, which have several rounds, which have several games. You must first create a tournament, then you can add rounds to them. - - name: FIDE + - name: Bulk pairings description: | - FIDE players and federations from [their public download](https://ratings.fide.com/download_lists.phtml). + Create many games for other players. - - - name: Analysis + These endpoints are intended for tournament organisers. + - name: Challenges description: | - Access Lichess cloud evaluations database. - + Send and receive challenges to play. + + To create a lot of challenges, consider [bulk pairing](#tag/bulk-pairings/post/apibulk-pairing) instead. - name: External engine description: | **This API is in alpha and subject to change.** @@ -252,6 +195,19 @@ tags: External engines can provide analysis on pages like the [analysis board](https://lichess.org/analysis), running as a service outside of the browser, or even on a different machine. + - name: FIDE + description: | + FIDE players and federations from [their public download](https://ratings.fide.com/download_lists.phtml). + + + - name: Games + description: | + Access games played on Lichess. + + - name: Messaging + description: | + Private messages with other players. + - name: Opening Explorer description: | Lookup positions from the [Lichess opening explorer](https://lichess.org/analysis#explorer). @@ -259,11 +215,54 @@ tags: Runs . **The endpoint hostname is not lichess.org but explorer.lichess.ovh.** + - name: Puzzles + description: | + Access Lichess [puzzle history and dashboard](https://lichess.org/training). + + Our collection of puzzles is in the public domain, you can [download it here](https://database.lichess.org/#puzzles). + For a list of our puzzle themes with their description, check out the [theme translation file](https://github.com/ornicar/lila/blob/master/translation/source/puzzleTheme.xml). + The daily puzzle can be [posted in your slack workspace](https://lichess.org/daily-puzzle-slack). + - name: Relations + description: | + Access relations between users. + - name: Simuls + description: | + Access simuls played on Lichess. + + - name: Studies + description: | + Access Lichess studies. + - name: Tablebase description: | Lookup positions from the [Lichess tablebase server](https://lichess.org/blog/W3WeMyQAACQAdfAL/7-piece-syzygy-tablebases-are-complete). **The endpoint hostname is not lichess.org but tablebase.lichess.ovh.** + - name: Teams + description: | + Access and manage Lichess teams and their members. + + - name: Tournaments (Arena) + description: | + Access Arena tournaments played on Lichess. + [Official Arena tournaments](https://lichess.org/tournament) are maintained by Lichess, + but you can [create your own Arena tournaments](https://lichess.org/tournament/new) as well. + - name: Tournaments (Swiss) + description: | + Access Swiss tournaments played on Lichess. + [Read more about Swiss tournaments.](https://lichess.org/swiss). + - name: TV + description: | + Access Lichess TV channels and games. + & + - name: Users + description: | + Access registered users on Lichess. + + + - Each user blog exposes an atom (RSS) feed, like + - User blogs mashup feed: https://lichess.org/blog/community.atom + - User blogs mashup feed for a language: https://lichess.org/blog/community/fr.atom - name: OAuth description: | Obtaining and revoking OAuth tokens. diff --git a/doc/specs/tags/arenatournaments/api-tournament-id-games.yaml b/doc/specs/tags/arenatournaments/api-tournament-id-games.yaml index 2b1cc6f5..f9ff2edc 100644 --- a/doc/specs/tags/arenatournaments/api-tournament-id-games.yaml +++ b/doc/specs/tags/arenatournaments/api-tournament-id-games.yaml @@ -8,7 +8,7 @@ get: - Anonymous request: 20 games per second - [OAuth2 authenticated](/#description/authentication) request: 30 games per second tags: - - "Arena tournaments" + - "Tournaments (Arena)" security: [] parameters: - $ref: "../../schemas/headers/AcceptPgnOrNdjson.yaml" diff --git a/doc/specs/tags/arenatournaments/api-tournament-id-join.yaml b/doc/specs/tags/arenatournaments/api-tournament-id-join.yaml index 3fb8950e..998aba23 100644 --- a/doc/specs/tags/arenatournaments/api-tournament-id-join.yaml +++ b/doc/specs/tags/arenatournaments/api-tournament-id-join.yaml @@ -5,7 +5,7 @@ post: Join an Arena tournament, possibly with a password and/or a team. Also unpauses if you had previously [paused](#tag/arena-tournaments/post/apitournamentidwithdraw) the tournament. tags: - - "Arena tournaments" + - "Tournaments (Arena)" security: - OAuth2: ["tournament:write"] parameters: diff --git a/doc/specs/tags/arenatournaments/api-tournament-id-results.yaml b/doc/specs/tags/arenatournaments/api-tournament-id-results.yaml index 2c411029..4862d3b5 100644 --- a/doc/specs/tags/arenatournaments/api-tournament-id-results.yaml +++ b/doc/specs/tags/arenatournaments/api-tournament-id-results.yaml @@ -8,7 +8,7 @@ get: due to ranking changes while the players are being streamed. Use on finished tournaments for guaranteed consistency. tags: - - "Arena tournaments" + - "Tournaments (Arena)" security: [] parameters: - in: path diff --git a/doc/specs/tags/arenatournaments/api-tournament-id-teams.yaml b/doc/specs/tags/arenatournaments/api-tournament-id-teams.yaml index 65d4b147..8140e8d6 100644 --- a/doc/specs/tags/arenatournaments/api-tournament-id-teams.yaml +++ b/doc/specs/tags/arenatournaments/api-tournament-id-teams.yaml @@ -4,7 +4,7 @@ get: description: | Teams of a team battle tournament, with top players, sorted by rank (best first). tags: - - "Arena tournaments" + - "Tournaments (Arena)" security: [] parameters: - in: path diff --git a/doc/specs/tags/arenatournaments/api-tournament-id-terminate.yaml b/doc/specs/tags/arenatournaments/api-tournament-id-terminate.yaml index ce05445d..e8f9670f 100644 --- a/doc/specs/tags/arenatournaments/api-tournament-id-terminate.yaml +++ b/doc/specs/tags/arenatournaments/api-tournament-id-terminate.yaml @@ -4,7 +4,7 @@ post: description: | Terminate an Arena tournament tags: - - "Arena tournaments" + - "Tournaments (Arena)" security: - OAuth2: ["tournament:write"] parameters: diff --git a/doc/specs/tags/arenatournaments/api-tournament-id-withdraw.yaml b/doc/specs/tags/arenatournaments/api-tournament-id-withdraw.yaml index 9499f425..171756a1 100644 --- a/doc/specs/tags/arenatournaments/api-tournament-id-withdraw.yaml +++ b/doc/specs/tags/arenatournaments/api-tournament-id-withdraw.yaml @@ -5,7 +5,7 @@ post: Leave a future Arena tournament, or take a break on an ongoing Arena tournament. It's possible to join again later. Points and streaks are preserved. tags: - - "Arena tournaments" + - "Tournaments (Arena)" security: - OAuth2: ["tournament:write"] parameters: diff --git a/doc/specs/tags/arenatournaments/api-tournament-id.yaml b/doc/specs/tags/arenatournaments/api-tournament-id.yaml index 75cd30bf..3f39fce9 100644 --- a/doc/specs/tags/arenatournaments/api-tournament-id.yaml +++ b/doc/specs/tags/arenatournaments/api-tournament-id.yaml @@ -11,7 +11,7 @@ get: description: | Get detailed info about recently finished, current, or upcoming tournament's duels, player standings, and other info. tags: - - "Arena tournaments" + - "Tournaments (Arena)" security: [] parameters: - in: query @@ -50,7 +50,7 @@ post: - 15s and 0+1 variant tournaments cannot be rated - Clock time in comparison to tournament length must be reasonable: 3 <= (minutes * 60) / (96 * clockTime + 48 * clockIncrement + 15) <= 150 tags: - - "Arena tournaments" + - "Tournaments (Arena)" security: - OAuth2: ["tournament:write"] requestBody: diff --git a/doc/specs/tags/arenatournaments/api-tournament-team-battle-id.yaml b/doc/specs/tags/arenatournaments/api-tournament-team-battle-id.yaml index f61efb79..3a2cc12d 100644 --- a/doc/specs/tags/arenatournaments/api-tournament-team-battle-id.yaml +++ b/doc/specs/tags/arenatournaments/api-tournament-team-battle-id.yaml @@ -5,7 +5,7 @@ post: Set the teams and number of leaders of a team battle. To update the other attributes of a team battle, use the [tournament update endpoint](#tag/arena-tournaments/post/apitournamentid). tags: - - "Arena tournaments" + - "Tournaments (Arena)" security: - OAuth2: ["tournament:write"] parameters: diff --git a/doc/specs/tags/arenatournaments/api-tournament.yaml b/doc/specs/tags/arenatournaments/api-tournament.yaml index 842187be..1f31e2e2 100644 --- a/doc/specs/tags/arenatournaments/api-tournament.yaml +++ b/doc/specs/tags/arenatournaments/api-tournament.yaml @@ -5,7 +5,7 @@ get: Get recently active and finished tournaments. This API is used to display the [Lichess tournament schedule](https://lichess.org/tournament). tags: - - "Arena tournaments" + - "Tournaments (Arena)" security: [] responses: "200": @@ -35,7 +35,7 @@ post: - 15s and 0+1 variant tournaments cannot be rated - Clock time in comparison to tournament length must be reasonable: 3 <= (minutes * 60) / (96 * clockTime + 48 * clockIncrement + 15) <= 150 tags: - - "Arena tournaments" + - "Tournaments (Arena)" security: - OAuth2: ["tournament:write"] requestBody: diff --git a/doc/specs/tags/arenatournaments/api-user-username-tournament-created.yaml b/doc/specs/tags/arenatournaments/api-user-username-tournament-created.yaml index 487d52d4..eb34fe1d 100644 --- a/doc/specs/tags/arenatournaments/api-user-username-tournament-created.yaml +++ b/doc/specs/tags/arenatournaments/api-user-username-tournament-created.yaml @@ -10,7 +10,7 @@ get: - [OAuth2 authenticated](/#description/authentication) request: 30 tournaments per second - Authenticated, downloading your own tournaments: 50 tournaments per second tags: - - "Arena tournaments" + - "Tournaments (Arena)" security: - OAuth2: [] parameters: diff --git a/doc/specs/tags/arenatournaments/api-user-username-tournament-played.yaml b/doc/specs/tags/arenatournaments/api-user-username-tournament-played.yaml index 1b1cfa7e..aa6a2a91 100644 --- a/doc/specs/tags/arenatournaments/api-user-username-tournament-played.yaml +++ b/doc/specs/tags/arenatournaments/api-user-username-tournament-played.yaml @@ -10,7 +10,7 @@ get: - [OAuth2 authenticated](/#description/authentication) request: 30 tournaments per second - Authenticated, downloading your own tournaments: 50 tournaments per second tags: - - "Arena tournaments" + - "Tournaments (Arena)" security: - OAuth2: [] parameters: diff --git a/doc/specs/tags/swisstournaments/api-swiss-id-edit.yaml b/doc/specs/tags/swisstournaments/api-swiss-id-edit.yaml index f0514d46..b0f148ad 100644 --- a/doc/specs/tags/swisstournaments/api-swiss-id-edit.yaml +++ b/doc/specs/tags/swisstournaments/api-swiss-id-edit.yaml @@ -8,7 +8,7 @@ post: - clock.limit + clock.increment > 0 - 15s and 0+1 variant tournaments cannot be rated tags: - - "Swiss tournaments" + - "Tournaments (Swiss)" security: - OAuth2: ["tournament:write"] parameters: diff --git a/doc/specs/tags/swisstournaments/api-swiss-id-games.yaml b/doc/specs/tags/swisstournaments/api-swiss-id-games.yaml index c899146f..8a2b1976 100644 --- a/doc/specs/tags/swisstournaments/api-swiss-id-games.yaml +++ b/doc/specs/tags/swisstournaments/api-swiss-id-games.yaml @@ -8,7 +8,7 @@ get: - Anonymous request: 20 games per second - [OAuth2 authenticated](/#description/authentication) request: 30 games per second tags: - - "Swiss tournaments" + - "Tournaments (Swiss)" security: [] parameters: - $ref: "../../schemas/headers/AcceptPgnOrNdjson.yaml" diff --git a/doc/specs/tags/swisstournaments/api-swiss-id-join.yaml b/doc/specs/tags/swisstournaments/api-swiss-id-join.yaml index 8d0d2360..910a342e 100644 --- a/doc/specs/tags/swisstournaments/api-swiss-id-join.yaml +++ b/doc/specs/tags/swisstournaments/api-swiss-id-join.yaml @@ -4,7 +4,7 @@ post: description: | Join a Swiss tournament, possibly with a password. tags: - - "Swiss tournaments" + - "Tournaments (Swiss)" security: - OAuth2: ["tournament:write"] parameters: diff --git a/doc/specs/tags/swisstournaments/api-swiss-id-results.yaml b/doc/specs/tags/swisstournaments/api-swiss-id-results.yaml index a60177c7..9818cc1d 100644 --- a/doc/specs/tags/swisstournaments/api-swiss-id-results.yaml +++ b/doc/specs/tags/swisstournaments/api-swiss-id-results.yaml @@ -8,7 +8,7 @@ get: due to ranking changes while the players are being streamed. Use on finished tournaments for guaranteed consistency. tags: - - "Swiss tournaments" + - "Tournaments (Swiss)" security: [] parameters: - in: path diff --git a/doc/specs/tags/swisstournaments/api-swiss-id-schedule-next-round.yaml b/doc/specs/tags/swisstournaments/api-swiss-id-schedule-next-round.yaml index 0b42e3d1..23b22c3e 100644 --- a/doc/specs/tags/swisstournaments/api-swiss-id-schedule-next-round.yaml +++ b/doc/specs/tags/swisstournaments/api-swiss-id-schedule-next-round.yaml @@ -6,7 +6,7 @@ post: This sets the `roundInterval` field to `99999999`, i.e. manual scheduling. All further rounds will need to be manually scheduled, unless the `roundInterval` field is changed back to automatic scheduling. tags: - - "Swiss tournaments" + - "Tournaments (Swiss)" security: - OAuth2: ["tournament:write"] parameters: diff --git a/doc/specs/tags/swisstournaments/api-swiss-id-terminate.yaml b/doc/specs/tags/swisstournaments/api-swiss-id-terminate.yaml index ebebaa87..94b2901d 100644 --- a/doc/specs/tags/swisstournaments/api-swiss-id-terminate.yaml +++ b/doc/specs/tags/swisstournaments/api-swiss-id-terminate.yaml @@ -4,7 +4,7 @@ post: description: | Terminate a Swiss tournament tags: - - "Swiss tournaments" + - "Tournaments (Swiss)" security: - OAuth2: ["tournament:write"] parameters: diff --git a/doc/specs/tags/swisstournaments/api-swiss-id-withdraw.yaml b/doc/specs/tags/swisstournaments/api-swiss-id-withdraw.yaml index dbdda194..faa7bc29 100644 --- a/doc/specs/tags/swisstournaments/api-swiss-id-withdraw.yaml +++ b/doc/specs/tags/swisstournaments/api-swiss-id-withdraw.yaml @@ -5,7 +5,7 @@ post: Leave a future Swiss tournament, or take a break on an ongoing Swiss tournament. It's possible to join again later. Points are preserved. tags: - - "Swiss tournaments" + - "Tournaments (Swiss)" security: - OAuth2: ["tournament:write"] parameters: diff --git a/doc/specs/tags/swisstournaments/api-swiss-id.yaml b/doc/specs/tags/swisstournaments/api-swiss-id.yaml index ab000b2d..b77c5b4d 100644 --- a/doc/specs/tags/swisstournaments/api-swiss-id.yaml +++ b/doc/specs/tags/swisstournaments/api-swiss-id.yaml @@ -11,7 +11,7 @@ get: description: | Get detailed info about a Swiss tournament. tags: - - "Swiss tournaments" + - "Tournaments (Swiss)" security: [] responses: "200": diff --git a/doc/specs/tags/swisstournaments/api-swiss-new-teamId.yaml b/doc/specs/tags/swisstournaments/api-swiss-new-teamId.yaml index 7366087a..68319608 100644 --- a/doc/specs/tags/swisstournaments/api-swiss-new-teamId.yaml +++ b/doc/specs/tags/swisstournaments/api-swiss-new-teamId.yaml @@ -9,7 +9,7 @@ post: - clock.limit + clock.increment > 0 - 15s and 0+1 variant tournaments cannot be rated tags: - - "Swiss tournaments" + - "Tournaments (Swiss)" security: - OAuth2: ["tournament:write"] parameters: diff --git a/doc/specs/tags/swisstournaments/swiss-id.trf.yaml b/doc/specs/tags/swisstournaments/swiss-id.trf.yaml index 9cd91a49..fe856b3e 100644 --- a/doc/specs/tags/swisstournaments/swiss-id.trf.yaml +++ b/doc/specs/tags/swisstournaments/swiss-id.trf.yaml @@ -6,7 +6,7 @@ get: Documentation: Example: tags: - - "Swiss tournaments" + - "Tournaments (Swiss)" security: [] parameters: - in: path diff --git a/doc/specs/tags/teams/api-team-teamId-arena.yaml b/doc/specs/tags/teams/api-team-teamId-arena.yaml index eb6ef338..4d78299f 100644 --- a/doc/specs/tags/teams/api-team-teamId-arena.yaml +++ b/doc/specs/tags/teams/api-team-teamId-arena.yaml @@ -7,7 +7,7 @@ get: Tournaments are streamed as [ndjson](#description/streaming-with-nd-json). tags: - Teams - - "Arena tournaments" + - "Tournaments (Arena)" security: [] parameters: - in: path diff --git a/doc/specs/tags/teams/api-team-teamId-swiss.yaml b/doc/specs/tags/teams/api-team-teamId-swiss.yaml index 77515765..1a122a0f 100644 --- a/doc/specs/tags/teams/api-team-teamId-swiss.yaml +++ b/doc/specs/tags/teams/api-team-teamId-swiss.yaml @@ -7,7 +7,7 @@ get: Tournaments are streamed as [ndjson](#description/streaming-with-nd-json). tags: - Teams - - "Swiss tournaments" + - "Tournaments (Swiss)" security: [] parameters: - in: path