docs(core): NowChess API Spec
Build & Test (NowChessSystems) TeamCity build finished

Changed format of endpoints for easier bot implementation later on
This commit is contained in:
LQ63
2026-04-12 16:38:53 +02:00
parent 4484ffa995
commit 2615152067
+13 -13
View File
@@ -60,7 +60,7 @@ paths:
# Game lifecycle # Game lifecycle
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------
/api/game: /api/board/game:
post: post:
operationId: createGame operationId: createGame
tags: [game] tags: [game]
@@ -90,7 +90,7 @@ paths:
'429': '429':
$ref: '#/components/responses/TooManyRequests' $ref: '#/components/responses/TooManyRequests'
/api/game/{gameId}: /api/board/game/{gameId}:
get: get:
operationId: getGame operationId: getGame
tags: [game] tags: [game]
@@ -112,7 +112,7 @@ paths:
'429': '429':
$ref: '#/components/responses/TooManyRequests' $ref: '#/components/responses/TooManyRequests'
/api/game/{gameId}/stream: /api/board/game/{gameId}/stream:
get: get:
operationId: streamGame operationId: streamGame
tags: [game] tags: [game]
@@ -148,7 +148,7 @@ paths:
'429': '429':
$ref: '#/components/responses/TooManyRequests' $ref: '#/components/responses/TooManyRequests'
/api/game/{gameId}/resign: /api/board/game/{gameId}/resign:
post: post:
operationId: resignGame operationId: resignGame
tags: [game] tags: [game]
@@ -176,7 +176,7 @@ paths:
# Move-making # Move-making
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------
/api/game/{gameId}/move/{uci}: /api/board/game/{gameId}/move/{uci}:
post: post:
operationId: makeMove operationId: makeMove
tags: [move] tags: [move]
@@ -217,7 +217,7 @@ paths:
'429': '429':
$ref: '#/components/responses/TooManyRequests' $ref: '#/components/responses/TooManyRequests'
/api/game/{gameId}/moves: /api/board/game/{gameId}/moves:
get: get:
operationId: getLegalMoves operationId: getLegalMoves
tags: [move] tags: [move]
@@ -249,7 +249,7 @@ paths:
'429': '429':
$ref: '#/components/responses/TooManyRequests' $ref: '#/components/responses/TooManyRequests'
/api/game/{gameId}/undo: /api/board/game/{gameId}/undo:
post: post:
operationId: undoMove operationId: undoMove
tags: [move] tags: [move]
@@ -277,7 +277,7 @@ paths:
'429': '429':
$ref: '#/components/responses/TooManyRequests' $ref: '#/components/responses/TooManyRequests'
/api/game/{gameId}/redo: /api/board/game/{gameId}/redo:
post: post:
operationId: redoMove operationId: redoMove
tags: [move] tags: [move]
@@ -309,7 +309,7 @@ paths:
# Draw handling # Draw handling
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------
/api/game/{gameId}/draw/{action}: /api/board/game/{gameId}/draw/{action}:
post: post:
operationId: drawAction operationId: drawAction
tags: [draw] tags: [draw]
@@ -351,7 +351,7 @@ paths:
# Import # Import
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------
/api/game/import/fen: /api/board/game/import/fen:
post: post:
operationId: importFen operationId: importFen
tags: [import] tags: [import]
@@ -380,7 +380,7 @@ paths:
'429': '429':
$ref: '#/components/responses/TooManyRequests' $ref: '#/components/responses/TooManyRequests'
/api/game/import/pgn: /api/board/game/import/pgn:
post: post:
operationId: importPgn operationId: importPgn
tags: [import] tags: [import]
@@ -413,7 +413,7 @@ paths:
# Export # Export
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------
/api/game/{gameId}/export/fen: /api/board/game/{gameId}/export/fen:
get: get:
operationId: exportFen operationId: exportFen
tags: [export] tags: [export]
@@ -436,7 +436,7 @@ paths:
'429': '429':
$ref: '#/components/responses/TooManyRequests' $ref: '#/components/responses/TooManyRequests'
/api/game/{gameId}/export/pgn: /api/board/game/{gameId}/export/pgn:
get: get:
operationId: exportPgn operationId: exportPgn
tags: [export] tags: [export]