Skip to content

Commit bbee278

Browse files
committed
alphabetical order for sidebar sections
with exception for oauth to keep it at bottom
1 parent db8657d commit bbee278

24 files changed

+91
-92
lines changed

doc/specs/lichess-api.yaml

Lines changed: 66 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -106,37 +106,10 @@ tags:
106106
description: |
107107
Read and write account information and preferences.
108108
<https://lichess.org/account/preferences/game-display>
109-
- name: Users
110-
description: |
111-
Access registered users on Lichess.
112-
<https://lichess.org/player>
113-
114-
- Each user blog exposes an atom (RSS) feed, like <https://lichess.org/@/thibault/blog.atom>
115-
- User blogs mashup feed: https://lichess.org/blog/community.atom
116-
- User blogs mashup feed for a language: https://lichess.org/blog/community/fr.atom
117-
118-
- name: Relations
119-
description: |
120-
Access relations between users.
121-
- name: Games
122-
description: |
123-
Access games played on Lichess.
124-
<https://lichess.org/games>
125-
- name: TV
126-
description: |
127-
Access Lichess TV channels and games.
128-
<https://lichess.org/tv> & <https://lichess.org/games>
129-
- name: Puzzles
130-
description: |
131-
Access Lichess [puzzle history and dashboard](https://lichess.org/training).
132-
133-
Our collection of puzzles is in the public domain, you can [download it here](https://database.lichess.org/#puzzles).
134-
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).
135-
The daily puzzle can be [posted in your slack workspace](https://lichess.org/daily-puzzle-slack).
136-
- name: Teams
109+
- name: Analysis
137110
description: |
138-
Access and manage Lichess teams and their members.
139-
<https://lichess.org/team>
111+
Access Lichess cloud evaluations database.
112+
<https://lichess.org/analysis>
140113
- name: Board
141114
description: |
142115
Play on Lichess with physical boards and third-party clients.
@@ -193,37 +166,6 @@ tags:
193166
- Join the [Lichess Bots team](https://lichess.org/team/lichess-bots) with your bot account
194167
- [Get help in the discord channel](https://discord.gg/quwueFd)
195168
- Watch [Lichess Bot TV](https://lichess.org/tv/bot)
196-
- name: Challenges
197-
description: |
198-
Send and receive challenges to play.
199-
200-
To create a lot of challenges, consider [bulk pairing](#tag/bulk-pairings/post/apibulk-pairing) instead.
201-
- name: Bulk pairings
202-
description: |
203-
Create many games for other players.
204-
205-
These endpoints are intended for tournament organisers.
206-
- name: Arena tournaments
207-
description: |
208-
Access Arena tournaments played on Lichess.
209-
[Official Arena tournaments](https://lichess.org/tournament) are maintained by Lichess,
210-
but you can [create your own Arena tournaments](https://lichess.org/tournament/new) as well.
211-
- name: Swiss tournaments
212-
description: |
213-
Access Swiss tournaments played on Lichess.
214-
[Read more about Swiss tournaments.](https://lichess.org/swiss).
215-
- name: Simuls
216-
description: |
217-
Access simuls played on Lichess.
218-
<https://lichess.org/simul>
219-
- name: Studies
220-
description: |
221-
Access Lichess studies.
222-
<https://lichess.org/study>
223-
- name: Messaging
224-
description: |
225-
Private messages with other players.
226-
<https://lichess.org/inbox>
227169
- name: Broadcasts
228170
description: |
229171
Relay chess events on Lichess.
@@ -234,15 +176,16 @@ tags:
234176
235177
Broadcasts are organized in tournaments, which have several rounds, which have several games.
236178
You must first create a tournament, then you can add rounds to them.
237-
- name: FIDE
179+
- name: Bulk pairings
238180
description: |
239-
FIDE players and federations from [their public download](https://ratings.fide.com/download_lists.phtml).
181+
Create many games for other players.
240182
241-
<https://lichess.org/fide>
242-
- name: Analysis
183+
These endpoints are intended for tournament organisers.
184+
- name: Challenges
243185
description: |
244-
Access Lichess cloud evaluations database.
245-
<https://lichess.org/analysis>
186+
Send and receive challenges to play.
187+
188+
To create a lot of challenges, consider [bulk pairing](#tag/bulk-pairings/post/apibulk-pairing) instead.
246189
- name: External engine
247190
description: |
248191
**This API is in alpha and subject to change.**
@@ -252,18 +195,74 @@ tags:
252195
External engines can provide analysis on pages like the
253196
[analysis board](https://lichess.org/analysis), running as a service
254197
outside of the browser, or even on a different machine.
198+
- name: FIDE
199+
description: |
200+
FIDE players and federations from [their public download](https://ratings.fide.com/download_lists.phtml).
201+
202+
<https://lichess.org/fide>
203+
- name: Games
204+
description: |
205+
Access games played on Lichess.
206+
<https://lichess.org/games>
207+
- name: Messaging
208+
description: |
209+
Private messages with other players.
210+
<https://lichess.org/inbox>
255211
- name: Opening Explorer
256212
description: |
257213
Lookup positions from the [Lichess opening explorer](https://lichess.org/analysis#explorer).
258214
259215
Runs <https://github.com/lichess-org/lila-openingexplorer>.
260216
261217
**The endpoint hostname is not lichess.org but explorer.lichess.ovh.**
218+
- name: Puzzles
219+
description: |
220+
Access Lichess [puzzle history and dashboard](https://lichess.org/training).
221+
222+
Our collection of puzzles is in the public domain, you can [download it here](https://database.lichess.org/#puzzles).
223+
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).
224+
The daily puzzle can be [posted in your slack workspace](https://lichess.org/daily-puzzle-slack).
225+
- name: Relations
226+
description: |
227+
Access relations between users.
228+
- name: Simuls
229+
description: |
230+
Access simuls played on Lichess.
231+
<https://lichess.org/simul>
232+
- name: Studies
233+
description: |
234+
Access Lichess studies.
235+
<https://lichess.org/study>
262236
- name: Tablebase
263237
description: |
264238
Lookup positions from the [Lichess tablebase server](https://lichess.org/blog/W3WeMyQAACQAdfAL/7-piece-syzygy-tablebases-are-complete).
265239
266240
**The endpoint hostname is not lichess.org but tablebase.lichess.ovh.**
241+
- name: Teams
242+
description: |
243+
Access and manage Lichess teams and their members.
244+
<https://lichess.org/team>
245+
- name: Tournaments (Arena)
246+
description: |
247+
Access Arena tournaments played on Lichess.
248+
[Official Arena tournaments](https://lichess.org/tournament) are maintained by Lichess,
249+
but you can [create your own Arena tournaments](https://lichess.org/tournament/new) as well.
250+
- name: Tournaments (Swiss)
251+
description: |
252+
Access Swiss tournaments played on Lichess.
253+
[Read more about Swiss tournaments.](https://lichess.org/swiss).
254+
- name: TV
255+
description: |
256+
Access Lichess TV channels and games.
257+
<https://lichess.org/tv> & <https://lichess.org/games>
258+
- name: Users
259+
description: |
260+
Access registered users on Lichess.
261+
<https://lichess.org/player>
262+
263+
- Each user blog exposes an atom (RSS) feed, like <https://lichess.org/@/thibault/blog.atom>
264+
- User blogs mashup feed: https://lichess.org/blog/community.atom
265+
- User blogs mashup feed for a language: https://lichess.org/blog/community/fr.atom
267266
- name: OAuth
268267
description: |
269268
Obtaining and revoking OAuth tokens.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ get:
88
- Anonymous request: 20 games per second
99
- [OAuth2 authenticated](/#description/authentication) request: 30 games per second
1010
tags:
11-
- "Arena tournaments"
11+
- "Tournaments (Arena)"
1212
security: []
1313
parameters:
1414
- $ref: "../../schemas/headers/AcceptPgnOrNdjson.yaml"

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ post:
55
Join an Arena tournament, possibly with a password and/or a team.
66
Also unpauses if you had previously [paused](#tag/arena-tournaments/post/apitournamentidwithdraw) the tournament.
77
tags:
8-
- "Arena tournaments"
8+
- "Tournaments (Arena)"
99
security:
1010
- OAuth2: ["tournament:write"]
1111
parameters:

doc/specs/tags/arenatournaments/api-tournament-id-results.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ get:
88
due to ranking changes while the players are being streamed.
99
Use on finished tournaments for guaranteed consistency.
1010
tags:
11-
- "Arena tournaments"
11+
- "Tournaments (Arena)"
1212
security: []
1313
parameters:
1414
- in: path

doc/specs/tags/arenatournaments/api-tournament-id-teams.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ get:
44
description: |
55
Teams of a team battle tournament, with top players, sorted by rank (best first).
66
tags:
7-
- "Arena tournaments"
7+
- "Tournaments (Arena)"
88
security: []
99
parameters:
1010
- in: path

doc/specs/tags/arenatournaments/api-tournament-id-terminate.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ post:
44
description: |
55
Terminate an Arena tournament
66
tags:
7-
- "Arena tournaments"
7+
- "Tournaments (Arena)"
88
security:
99
- OAuth2: ["tournament:write"]
1010
parameters:

doc/specs/tags/arenatournaments/api-tournament-id-withdraw.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ post:
55
Leave a future Arena tournament, or take a break on an ongoing Arena tournament.
66
It's possible to join again later. Points and streaks are preserved.
77
tags:
8-
- "Arena tournaments"
8+
- "Tournaments (Arena)"
99
security:
1010
- OAuth2: ["tournament:write"]
1111
parameters:

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ get:
1111
description: |
1212
Get detailed info about recently finished, current, or upcoming tournament's duels, player standings, and other info.
1313
tags:
14-
- "Arena tournaments"
14+
- "Tournaments (Arena)"
1515
security: []
1616
parameters:
1717
- in: query
@@ -50,7 +50,7 @@ post:
5050
- 15s and 0+1 variant tournaments cannot be rated
5151
- Clock time in comparison to tournament length must be reasonable: 3 <= (minutes * 60) / (96 * clockTime + 48 * clockIncrement + 15) <= 150
5252
tags:
53-
- "Arena tournaments"
53+
- "Tournaments (Arena)"
5454
security:
5555
- OAuth2: ["tournament:write"]
5656
requestBody:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ post:
55
Set the teams and number of leaders of a team battle.
66
To update the other attributes of a team battle, use the [tournament update endpoint](#tag/arena-tournaments/post/apitournamentid).
77
tags:
8-
- "Arena tournaments"
8+
- "Tournaments (Arena)"
99
security:
1010
- OAuth2: ["tournament:write"]
1111
parameters:

doc/specs/tags/arenatournaments/api-tournament.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ get:
55
Get recently active and finished tournaments.
66
This API is used to display the [Lichess tournament schedule](https://lichess.org/tournament).
77
tags:
8-
- "Arena tournaments"
8+
- "Tournaments (Arena)"
99
security: []
1010
responses:
1111
"200":
@@ -35,7 +35,7 @@ post:
3535
- 15s and 0+1 variant tournaments cannot be rated
3636
- Clock time in comparison to tournament length must be reasonable: 3 <= (minutes * 60) / (96 * clockTime + 48 * clockIncrement + 15) <= 150
3737
tags:
38-
- "Arena tournaments"
38+
- "Tournaments (Arena)"
3939
security:
4040
- OAuth2: ["tournament:write"]
4141
requestBody:

0 commit comments

Comments
 (0)