Merge pull request #331 from tors42/fix-warnings

Fix warnings

doc/redocly.yaml

@@ -7,3 +7,9 @@ extends:
 
 rules:
   operation-4xx-response: off
+  no-ambiguous-paths: off # 25 warnings, 2024-04-09
+  # Example ambiguous paths:
+  # /api/tournament/{id1}/join
+  # /api/tournament/team-battle/{id2}
+  # If id1 has value "team-battle", and id2 has value "join",
+  # these paths would be identical...

doc/specs/examples/challenge.yaml → doc/specs/examples/challenge.json

@@ -1,4 +1,4 @@
-value: {
+{
   "type":"challenge",
   "challenge": {
     "id":"7pGLxJ4F",

doc/specs/examples/challengeCanceled.yaml → doc/specs/examples/challengeCanceled.json

@@ -1,4 +1,4 @@
-value: {
+{
   "type":"challengeCanceled",
   "challenge": {
     "id":"7pGLxJ4F",

doc/specs/examples/challengeDeclined.yaml → doc/specs/examples/challengeDeclined.json

@@ -1,4 +1,4 @@
-value: {
+{
   "type": "challengeDeclined",
   "challenge": {
     "id":"7pGLxJ4F",

doc/specs/examples/chatLine.yaml → doc/specs/examples/chatLine.json

@@ -1,4 +1,4 @@
-value: {
+{
   "type": "chatLine",
   "username": "thibault",
   "text": "Good luck, have fun",

doc/specs/examples/gameFinish.yaml → doc/specs/examples/gameFinish.json

@@ -1,4 +1,4 @@
-value: {
+{
   "type":"gameFinish",
   "game": {
     "gameId": "rCRw1AuO",

doc/specs/examples/gameFull.yaml → doc/specs/examples/gameFull.json

@@ -1,4 +1,4 @@
-value: {
+{
   "type": "gameFull",
   "id": "5IrD6Gzz",
   "rated": true,
@@ -26,7 +26,7 @@ value: {
   "black": {
     "id": "leela",
     "name": "leela",
-    "rating": 2390,
+    "rating": 2390
   },
   "initialFen": "startpos",
   "state": {

doc/specs/examples/gameStart.yaml → doc/specs/examples/gameStart.json

@@ -1,4 +1,4 @@
-value: {
+{
   "type":"gameStart",
   "game": {
     "gameId": "rCRw1AuO",

doc/specs/examples/gameState.yaml → doc/specs/examples/gameState.json

@@ -1,4 +1,4 @@
-value: {
+{
   "type": "gameState",
   "moves": "e2e4 c7c5 f2f4 d7d6 g1f3 b8c6 f1c4 g8f6 d2d3 g7g6 e1g1 f8g7 b1c3",
   "wtime": 7598040,

doc/specs/examples/opponentGoneTrue.yaml → doc/specs/examples/opponentGone.json

@@ -1,4 +1,4 @@
-value: {
+{
   "type": "opponentGone",
   "gone": true,
   "claimWinInSeconds": 8

doc/specs/lichess-api.yaml

@@ -715,7 +715,3 @@ components:
             "board:play": Play with the Board API
             "bot:play": Play with the Bot API. Only for [Bot accounts](#operation/botAccountUpgrade)
             "web:mod": Use moderator tools (within the bounds of your permissions)
-
-  examples:
-    $ref: './examples/_index.yaml'
-

doc/specs/schemas/ChallengeCanceledEvent.yaml

@@ -5,3 +5,5 @@ properties:
     const: challengeCanceled
   challenge:
     $ref: './ChallengeJson.yaml'
+example:
+  $ref: '../examples/challengeCanceled.json'

doc/specs/schemas/ChallengeDeclinedEvent.yaml

@@ -5,3 +5,5 @@ properties:
     const: challengeDeclined
   challenge:
     $ref: './ChallengeCanceledJson.yaml'
+example:
+  $ref: '../examples/challengeDeclined.json'

doc/specs/schemas/ChatLineEvent.yaml

@@ -17,3 +17,5 @@ required:
   - room
   - username
   - text
+example:
+  $ref: '../examples/chatLine.json'

doc/specs/schemas/GameFinishEvent.yaml

@@ -5,3 +5,5 @@ properties:
     const: gameFinish
   game:
     $ref: './GameEventInfo.yaml'
+example:
+  $ref: '../examples/gameFinish.json'

doc/specs/schemas/GameFullEvent.yaml

@@ -48,3 +48,5 @@ required:
   - black
   - initialFen
   - state
+example:
+  $ref: '../examples/gameFull.json'

doc/specs/schemas/GameStartEvent.yaml

@@ -5,3 +5,5 @@ properties:
     const: gameStart
   game:
     $ref: './GameEventInfo.yaml'
+example:
+  $ref: '../examples/gameStart.json'

doc/specs/schemas/GameStateEvent.yaml

@@ -43,3 +43,5 @@ required:
   - winc
   - binc
   - status
+example:
+  $ref: '../examples/gameState.json'

doc/specs/schemas/OpponentGone.yaml

@@ -10,3 +10,5 @@ properties:
 required:
   - type
   - gone
+example:
+  $ref: '../examples/opponentGone.json'

doc/specs/tags/board/api-board-game-stream-gameId.yaml

@@ -38,21 +38,6 @@ get:
               - $ref: '../../schemas/GameStateEvent.yaml'
               - $ref: '../../schemas/ChatLineEvent.yaml'
               - $ref: '../../schemas/OpponentGone.yaml'
-          examples:
-            gameFull:
-              $ref: '../../examples/gameFull.yaml'
-            gameState:
-              $ref: '../../examples/gameState.yaml'
-            chatLine:
-              $ref: '../../examples/chatLine.yaml'
-            chatLineSpectator:
-              $ref: '../../examples/chatLineSpectator.yaml'
-            opponentGoneTrue:
-              $ref: '../../examples/opponentGoneTrue.yaml'
-            opponentGoneFalse:
-              $ref: '../../examples/opponentGoneFalse.yaml'
-            gameStateResign:
-              $ref: '../../examples/gameStateResign.yaml'
     "404":
       description: The game was not found.
       content:

doc/specs/tags/board/api-stream-event.yaml

@@ -34,14 +34,3 @@ get:
               - $ref: '../../schemas/ChallengeEvent.yaml'
               - $ref: '../../schemas/ChallengeCanceledEvent.yaml'
               - $ref: '../../schemas/ChallengeDeclinedEvent.yaml'
-          examples:
-            challenge:
-              $ref: '../../examples/challenge.yaml'
-            challengeCanceled:
-              $ref: '../../examples/challengeCanceled.yaml'
-            challengeDeclined:
-              $ref: '../../examples/challengeDeclined.yaml'
-            gameStart:
-              $ref: '../../examples/gameStart.yaml'
-            gameFinish:
-              $ref: '../../examples/gameFinish.yaml'

doc/specs/tags/bot/api-bot-game-stream-gameId.yaml

@@ -37,21 +37,6 @@ get:
               - $ref: '../../schemas/GameStateEvent.yaml'
               - $ref: '../../schemas/ChatLineEvent.yaml'
               - $ref: '../../schemas/OpponentGone.yaml'
-          examples:
-            gameFull:
-              $ref: '../../examples/gameFull.yaml'
-            gameState:
-              $ref: '../../examples/gameState.yaml'
-            chatLine:
-              $ref: '../../examples/chatLine.yaml'
-            chatLineSpectator:
-              $ref: '../../examples/chatLineSpectator.yaml'
-            opponentGoneTrue:
-              $ref: '../../examples/opponentGoneTrue.yaml'
-            opponentGoneFalse:
-              $ref: '../../examples/opponentGoneFalse.yaml'
-            gameStateResign:
-              $ref: '../../examples/gameStateResign.yaml'
     "404":
       description: The bot game was not found.
       content: