Skip to content

add oneOf for other Game endpoints that can be pgn or ndjson #607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fitztrev wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add oneOf for other Game endpoints that can be pgn or ndjson #607

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
203 changes: 120 additions & 83 deletions doc/specs/examples/games-apiGamesUserJson.json.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,123 +1,160 @@
value:
{
"id": "OOrSy6bR",
"id": "kmVDKlen",
"rated": false,
"variant": "standard",
"speed": "blitz",
"perf": "blitz",
"createdAt": 1765649473247,
"lastMoveAt": 1765651240627,
"createdAt": 1769888061630,
"lastMoveAt": 1769888903341,
"status": "resign",
"source": "simul",
"players":
{
"white":
{
"user": { "name": "Lance5500", "title": "LM", "patron": true, "patronColor": 9, "id": "lance5500" },
"rating": 2762,
"analysis": { "inaccuracy": 1, "mistake": 0, "blunder": 2, "acpl": 62, "accuracy": 58 },
"user": { "name": "aliefe235", "id": "aliefe235" },
"rating": 1304,
"analysis": { "inaccuracy": 7, "mistake": 0, "blunder": 0, "acpl": 34, "accuracy": 91 },
},
"black":
{
"user": { "name": "Prodigy_Bowser", "id": "prodigy_bowser" },
"rating": 1955,
"analysis": { "inaccuracy": 0, "mistake": 0, "blunder": 3, "acpl": 44, "accuracy": 83 },
"user": { "name": "Lance5500", "title": "LM", "id": "lance5500" },
"rating": 2711,
"analysis": { "inaccuracy": 2, "mistake": 0, "blunder": 0, "acpl": 15, "accuracy": 96 },
},
},
"winner": "black",
"opening": { "eco": "D53", "name": "Queen's Gambit Declined", "ply": 8 },
"moves": "d4 d5 c4 e6 Nc3 Nf6 Bg5 Be7 e3 Nbd7 Nf3 a6 a3 dxc4 Bxc4 b5 Bd3 Bb7 O-O O-O b4 h6 Bh4 Nd5 Bxe7 Qxe7 Nxd5 Bxd5 e4 Bb7 Rc1 Rac8 Re1 Kh8 Qc2 Qd6 Qc3 Qf4 Re3 Nf6 h3 Bxe4 Bxe4 Nxe4 Qc6 f5 Qxa6 Ra8 Qc6 Rxa3 Rxa3 Rf6 Qxc7 e5 Qxe5 Qxc1+ Kh2 Qxa3",
"opening": { "eco": "B56", "name": "Sicilian Defense: Classical Variation", "ply": 10 },
"moves": "e4 c5 Nf3 d6 d4 Nf6 Nc3 cxd4 Nxd4 Nc6 Be3 Ng4 Bb5 Nxe3 Nxc6 Nxd1 Nxd8+ Kxd8 Rxd1 e6 O-O Ke7 Rfe1 g6 Rd2 a6 Bc4 b5 Bb3 Bb7 Red1 Rd8 f3 Bg7 Rd3 Rd7 Kf2 g5 h3 h5 Rh1 Bf6 Rg1 Rc7 g4 hxg4 hxg4 Be5 Rg2 Rhc8 Ke3 Bxc3 bxc3 Rxc3 Rxc3 Rxc3+ Kd2 Rxf3 Re2 Rf4 e5 Rxg4 exd6+ Kxd6 Re3 Rd4+ Rd3 Rxd3+ Kxd3 f5 Ke3 e5 Bg8 f4+ Kf2 g4 Bh7 g3+ Kg1 f3",
"analysis":
[
{ "eval": 17 },
{ "eval": 27 },
{ "eval": 18 },
{ "eval": 17 },
{ "eval": 25 },
{ "eval": 20 },
{ "eval": 31 },
{ "eval": 22 },
{ "eval": 24 },
{ "eval": 32 },
{ "eval": 26 },
{ "eval": 35 },
{ "eval": 32 },
{ "eval": 30 },
{ "eval": 0 },
{ "eval": 14 },
{ "eval": 13 },
{ "eval": 11 },
{ "eval": 17 },
{ "eval": 49 },
{ "eval": 4 },
{ "eval": 17 },
{ "eval": 13 },
{ "eval": 17 },
{ "eval": 8 },
{ "eval": -20 },
{ "eval": 15 },
{ "eval": -17 },
{ "eval": -36 },
{ "eval": -30 },
{ "eval": -25 },
{ "eval": 6 },
{ "eval": 5 },
{ "eval": 28 },
{ "eval": 13 },
{ "eval": 48 },
{ "eval": 59 },
{ "eval": 54 },
{ "eval": 58 },
{ "eval": 62 },
{ "eval": 48 },
{ "eval": 51 },
{ "eval": 53 },
{ "eval": 71 },
{ "eval": 70 },
{ "eval": 111 },
{ "eval": 56 },
{ "eval": 104 },
{ "eval": 110 },
{ "eval": 121 },
{ "eval": 119 },
{ "eval": -23 },
{ "eval": -15 },
{ "eval": -28 },
{ "eval": -47 },
{ "eval": -7 },
{ "eval": -31 },
{ "eval": -20 },
{
"eval": 364,
"best": "f8e8",
"variation": "Rfe8",
"judgment": { "name": "Blunder", "comment": "Blunder. Rfe8 was best." },
"eval": -94,
"best": "e4e5",
"variation": "e5",
"judgment": { "name": "Inaccuracy", "comment": "Inaccuracy. e5 was best." },
},
{ "eval": -56 },
{
"eval": -1,
"best": "g2g3",
"variation": "g3 Qg4 Ne5 Qh3 Bf1 Qh5 Be2 Qh3 Bf3 Kg8 Qc5 Ba8",
"judgment": { "name": "Blunder", "comment": "Blunder. g3 was best." },
"eval": -140,
"best": "b5f1",
"variation": "Bf1 Bh6 Rd3 Bg7 Red1 Be5 g3 g5 Ne2 Bd7 c3 Rhg8",
"judgment": { "name": "Inaccuracy", "comment": "Inaccuracy. Bf1 was best." },
},
{ "eval": 2 },
{ "eval": 2 },
{ "eval": 0 },
{ "eval": -24 },
{ "eval": -127 },
{ "eval": -153 },
{
"eval": -73,
"best": "f8h6",
"variation": "Bh6 Rd3",
"judgment": { "name": "Inaccuracy", "comment": "Inaccuracy. Bh6 was best." },
},
{ "eval": -81 },
{ "eval": -77 },
{
"eval": -146,
"best": "e4e5",
"variation": "e5 d5",
"judgment": { "name": "Inaccuracy", "comment": "Inaccuracy. e5 was best." },
},
{ "eval": -176 },
{ "eval": -166 },
{ "eval": -168 },
{ "eval": -155 },
{ "eval": -148 },
{ "eval": -170 },
{ "eval": -172 },
{ "eval": -221 },
{ "eval": -178 },
{ "eval": -205 },
{ "eval": -227 },
{
"eval": -299,
"best": "g1b1",
"variation": "Rb1 b4 Nd1 a5 c4 bxc3 Nxc3 Be5 Rd2 Ba6 Rc1 Rhc8",
"judgment": { "name": "Inaccuracy", "comment": "Inaccuracy. Rb1 was best." },
},
{ "eval": -286 },
{ "eval": -289 },
{ "eval": -296 },
{ "eval": -307 },
{ "eval": -298 },
{
"eval": 204,
"best": "e4f6",
"variation": "Nf6",
"judgment": { "name": "Blunder", "comment": "Blunder. Nf6 was best." },
"eval": -388,
"best": "a2a3",
"variation": "a3 Bxc3 bxc3 Rxc3 Ke3 a5 Kd2 R3c6 c3 Rh8 Re3 Rh1",
"judgment": { "name": "Inaccuracy", "comment": "Inaccuracy. a3 was best." },
},
{ "eval": 189 },
{ "eval": 241 },
{ "eval": -384 },
{ "eval": -353 },
{
"eval": 122,
"best": "a6e6",
"variation": "Qxe6 Rfe8 Qc6 Kh7 Rc2 Reb8 Qxc7 Qxc7 Rxc7 Rc8 Rxc8 Rxc8",
"judgment": { "name": "Inaccuracy", "comment": "Inaccuracy. Qxe6 was best." },
"eval": -270,
"best": "a6a5",
"variation": "a5 a3 a4 Ba2 Rxc3 Bb1 Ba6 Kd2 b4 Rxc3 Rxc3 axb4",
"judgment": { "name": "Inaccuracy", "comment": "Inaccuracy. a5 was best." },
},
{
"eval": 516,
"best": "f8b8",
"variation": "Rfb8",
"judgment": { "name": "Blunder", "comment": "Blunder. Rfb8 was best." },
"eval": -417,
"best": "e3d2",
"variation": "Kd2 R3c5 Kc1 Rh8 Rgd2 Rc6 a3 a5 Kb2 Rh1 c3 Ba6",
"judgment": { "name": "Inaccuracy", "comment": "Inaccuracy. Kd2 was best." },
},
{ "eval": 535 },
{ "eval": 576 },
{ "eval": 592 },
{ "eval": 592 },
{ "eval": -410 },
{
"eval": -422,
"best": "d4e5",
"variation": "dxe5 Re6 Re1 Rg6 Qc1 Nxf2 Qxf4 Nxh3+ Kf1 Nxf4 e6 Kh7",
"judgment": { "name": "Blunder", "comment": "Blunder. dxe5 was best." },
"eval": -547,
"best": "e3e2",
"variation": "Ke2 d5 exd5 Bxd5 Rg3 Bxb3 cxb3 Rc2+ Kd3 Rxa2 Rh3 a5",
"judgment": { "name": "Inaccuracy", "comment": "Inaccuracy. Ke2 was best." },
},
{ "eval": -436 },
{ "eval": -449 },
{ "eval": -452 },
{ "eval": -534 },
{ "eval": -548 },
{ "eval": -524 },
{ "eval": -571 },
{ "eval": -577 },
{ "eval": -574 },
{ "eval": -572 },
{ "eval": -564 },
{ "eval": -577 },
{ "eval": -628 },
{ "eval": -617 },
{ "eval": -629 },
{ "eval": -625 },
{ "eval": -688 },
{ "eval": -663 },
{ "eval": -703 },
{ "eval": -686 },
{ "eval": -659 },
{ "eval": -763 },
{ "eval": -839 },
{ "eval": -742 },
{ "eval": -830 },
{ "eval": -826 },
],
"clock": { "initial": 300, "increment": 3, "totalTime": 420 },
"division": { "middle": 16, "end": 56 },
"division": { "middle": 16, "end": 53 },
}
20 changes: 20 additions & 0 deletions doc/specs/examples/games-apiGamesUserPgn.pgn.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
value: |
[Event "Coach LM Lance5500 simul"]
[Site "https://lichess.org/kmVDKlen"]
[Date "2026.01.31"]
[Round "-"]
[White "aliefe235"]
[Black "Lance5500"]
[Result "0-1"]
[GameId "kmVDKlen"]
[UTCDate "2026.01.31"]
[UTCTime "19:34:21"]
[WhiteElo "1304"]
[BlackElo "2711"]
[BlackTitle "LM"]
[Variant "Standard"]
[TimeControl "300+3"]
[ECO "B56"]
[Termination "Normal"]

1. e4 c5 2. Nf3 d6 3. d4 Nf6 4. Nc3 cxd4 5. Nxd4 Nc6 6. Be3 Ng4 7. Bb5 Nxe3 8. Nxc6 Nxd1 9. Nxd8+ Kxd8 10. Rxd1 e6 11. O-O Ke7 12. Rfe1 g6 13. Rd2 a6 14. Bc4 b5 15. Bb3 Bb7 16. Red1 Rd8 17. f3 Bg7 18. Rd3 Rd7 19. Kf2 g5 20. h3 h5 21. Rh1 Bf6 22. Rg1 Rc7 23. g4 hxg4 24. hxg4 Be5 25. Rg2 Rhc8 26. Ke3 Bxc3 27. bxc3 Rxc3 28. Rxc3 Rxc3+ 29. Kd2 Rxf3 30. Re2 Rf4 31. e5 Rxg4 32. exd6+ Kxd6 33. Re3 Rd4+ 34. Rd3 Rxd3+ 35. Kxd3 f5 36. Ke3 e5 37. Bg8 f4+ 38. Kf2 g4 39. Bh7 g3+ 40. Kg1 f3 0-1
118 changes: 8 additions & 110 deletions doc/specs/examples/games-apiUserCurrentGameJson.json.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,123 +1,21 @@
value:
{
"id": "OOrSy6bR",
"id": "IlekPICj",
"rated": false,
"variant": "standard",
"speed": "blitz",
"perf": "blitz",
"createdAt": 1765649473247,
"lastMoveAt": 1765651240627,
"status": "resign",
"createdAt": 1769888061630,
"lastMoveAt": 1769888061630,
"status": "outoftime",
"source": "simul",
"players":
{
"white":
{
"user": { "name": "Lance5500", "title": "LM", "patron": true, "patronColor": 9, "id": "lance5500" },
"rating": 2762,
"analysis": { "inaccuracy": 1, "mistake": 0, "blunder": 2, "acpl": 62, "accuracy": 58 },
},
"black":
{
"user": { "name": "Prodigy_Bowser", "id": "prodigy_bowser" },
"rating": 1955,
"analysis": { "inaccuracy": 0, "mistake": 0, "blunder": 3, "acpl": 44, "accuracy": 83 },
},
"white": { "user": { "name": "chesslooksprof", "id": "chesslooksprof" }, "rating": 1262 },
"black": { "user": { "name": "Lance5500", "title": "LM", "id": "lance5500" }, "rating": 2711 },
},
"winner": "black",
"opening": { "eco": "D53", "name": "Queen's Gambit Declined", "ply": 8 },
"moves": "d4 d5 c4 e6 Nc3 Nf6 Bg5 Be7 e3 Nbd7 Nf3 a6 a3 dxc4 Bxc4 b5 Bd3 Bb7 O-O O-O b4 h6 Bh4 Nd5 Bxe7 Qxe7 Nxd5 Bxd5 e4 Bb7 Rc1 Rac8 Re1 Kh8 Qc2 Qd6 Qc3 Qf4 Re3 Nf6 h3 Bxe4 Bxe4 Nxe4 Qc6 f5 Qxa6 Ra8 Qc6 Rxa3 Rxa3 Rf6 Qxc7 e5 Qxe5 Qxc1+ Kh2 Qxa3",
"analysis":
[
{ "eval": 17 },
{ "eval": 27 },
{ "eval": 18 },
{ "eval": 17 },
{ "eval": 22 },
{ "eval": 24 },
{ "eval": 0 },
{ "eval": 14 },
{ "eval": 13 },
{ "eval": 11 },
{ "eval": 17 },
{ "eval": 49 },
{ "eval": 4 },
{ "eval": 17 },
{ "eval": 13 },
{ "eval": 17 },
{ "eval": -20 },
{ "eval": 15 },
{ "eval": -25 },
{ "eval": 6 },
{ "eval": 5 },
{ "eval": 28 },
{ "eval": 13 },
{ "eval": 48 },
{ "eval": 59 },
{ "eval": 54 },
{ "eval": 58 },
{ "eval": 62 },
{ "eval": 48 },
{ "eval": 51 },
{ "eval": 53 },
{ "eval": 71 },
{ "eval": 70 },
{ "eval": 111 },
{ "eval": 56 },
{ "eval": 104 },
{ "eval": 110 },
{ "eval": 121 },
{ "eval": 119 },
{
"eval": 364,
"best": "f8e8",
"variation": "Rfe8",
"judgment": { "name": "Blunder", "comment": "Blunder. Rfe8 was best." },
},
{
"eval": -1,
"best": "g2g3",
"variation": "g3 Qg4 Ne5 Qh3 Bf1 Qh5 Be2 Qh3 Bf3 Kg8 Qc5 Ba8",
"judgment": { "name": "Blunder", "comment": "Blunder. g3 was best." },
},
{ "eval": 2 },
{ "eval": 2 },
{ "eval": 0 },
{ "eval": -24 },
{
"eval": 204,
"best": "e4f6",
"variation": "Nf6",
"judgment": { "name": "Blunder", "comment": "Blunder. Nf6 was best." },
},
{ "eval": 189 },
{ "eval": 241 },
{
"eval": 122,
"best": "a6e6",
"variation": "Qxe6 Rfe8 Qc6 Kh7 Rc2 Reb8 Qxc7 Qxc7 Rxc7 Rc8 Rxc8 Rxc8",
"judgment": { "name": "Inaccuracy", "comment": "Inaccuracy. Qxe6 was best." },
},
{
"eval": 516,
"best": "f8b8",
"variation": "Rfb8",
"judgment": { "name": "Blunder", "comment": "Blunder. Rfb8 was best." },
},
{ "eval": 535 },
{ "eval": 576 },
{ "eval": 592 },
{ "eval": 592 },
{
"eval": -422,
"best": "d4e5",
"variation": "dxe5 Re6 Re1 Rg6 Qc1 Nxf2 Qxf4 Nxh3+ Kf1 Nxf4 e6 Kh7",
"judgment": { "name": "Blunder", "comment": "Blunder. dxe5 was best." },
},
{ "eval": -436 },
{ "eval": -449 },
{ "eval": -452 },
],
"moves": "",
"clock": { "initial": 300, "increment": 3, "totalTime": 420 },
"division": { "middle": 16, "end": 56 },
"division": {},
}
Loading