Merge pull request #639 from lichess-org/scalar-explorer-endpoint

Fix hostnames used by Scalar's "Test Request" UI

Author: fitztrev

doc/specs/lichess-api.yaml

@@ -219,7 +219,8 @@ tags:
 
       Runs <https://github.com/lichess-org/lila-openingexplorer>.
 
-      **The endpoint hostname is not lichess.org but explorer.lichess.org.**
+      > [!important]
+      > The hostname for these endpoints is `explorer.lichess.org` and not `lichess.org`.
   - name: Puzzles
     description: |
       Fetch and solve [puzzles](https://lichess.org/training), view your puzzle history and dashboard.
@@ -241,7 +242,8 @@ tags:
     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.org.**
+      > [!important]
+      > The hostname for these endpoints is `tablebase.lichess.org` and not `lichess.org`.
   - name: Teams
     description: |
       Access and manage Lichess teams and their members.

doc/specs/tags/externalengine/api-external-engine-id-analyse.yaml

@@ -1,5 +1,3 @@
-servers:
-  - url: https://engine.lichess.ovh
 parameters:
   - in: path
     name: id
@@ -13,6 +11,12 @@ post:
   summary: Analyse with external engine
   tags:
     - External engine
+  servers:
+    - url: https://engine.lichess.ovh
+    - url: http://localhost:{port}
+      variables:
+        port:
+          default: "9666"
   security: []
   description: |
     **Endpoint: `https://engine.lichess.ovh/api/external-engine/{id}/analyse`**

doc/specs/tags/externalengine/api-external-engine-work-id.yaml

@@ -1,5 +1,3 @@
-servers:
-  - url: https://engine.lichess.ovh
 parameters:
   - in: path
     name: id
@@ -12,6 +10,12 @@ post:
   summary: Answer analysis request
   tags:
     - External engine
+  servers:
+    - url: https://engine.lichess.ovh
+    - url: http://localhost:{port}
+      variables:
+        port:
+          default: "9666"
   security: []
   description: |
     **Endpoint: `https://engine.lichess.ovh/api/external-engine/work/{id}`**

doc/specs/tags/externalengine/api-external-engine-work.yaml

@@ -1,18 +1,22 @@
-servers:
-  - url: https://engine.lichess.ovh
 post:
   operationId: apiExternalEngineAcquire
   summary: Acquire analysis request
   tags:
     - External engine
+  servers:
+    - url: https://engine.lichess.ovh
+    - url: http://localhost:{port}
+      variables:
+        port:
+          default: "9666"
   security: []
   description: |
     **Endpoint: `https://engine.lichess.ovh/api/external-engine/work`**
     Wait for an analysis requests to any of the external engines that
     have been registered with the given `secret`.
     Uses long polling.
     After acquiring a request, the provider should immediately
-    [start streaming the results](#tag/external-engine/POST/api/external-engine/workid).
+    [start streaming the results](#tag/external-engine/POST/api/external-engine/work/{id}).
   requestBody:
     description: Provider credentials.
     required: true

doc/specs/tags/openingexplorer/lichess.yaml

@@ -1,5 +1,3 @@
-servers:
-  - url: https://explorer.lichess.org
 get:
   operationId: openingExplorerLichess
   summary: Lichess games
@@ -11,6 +9,12 @@ get:
     Example: `curl https://explorer.lichess.org/lichess?variant=standard&speeds=blitz,rapid,classical&ratings=2200,2500&fen=rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR%20w%20KQkq%20-%200%201`
   tags:
     - Opening Explorer
+  servers:
+    - url: https://explorer.lichess.org
+    - url: http://localhost:{port}
+      variables:
+        port:
+          default: "9002"
   security:
     - OAuth2: []
   parameters:

doc/specs/tags/openingexplorer/masters-pgn-gameId.yaml

@@ -1,5 +1,3 @@
-servers:
-  - url: https://explorer.lichess.org
 get:
   operationId: openingExplorerMasterGame
   summary: OTB master game
@@ -9,6 +7,12 @@ get:
     Example: `curl https://explorer.lichess.org/masters/pgn/aAbqI4ey`
   tags:
     - Opening Explorer
+  servers:
+    - url: https://explorer.lichess.org
+    - url: http://localhost:{port}
+      variables:
+        port:
+          default: "9002"
   security:
     - OAuth2: []
   parameters:

doc/specs/tags/openingexplorer/masters.yaml

@@ -1,5 +1,3 @@
-servers:
-  - url: https://explorer.lichess.org
 get:
   operationId: openingExplorerMaster
   summary: Masters database
@@ -9,6 +7,12 @@ get:
     Example: `curl https://explorer.lichess.org/masters?play=d2d4,d7d5,c2c4,c7c6,c4d5`
   tags:
     - Opening Explorer
+  servers:
+    - url: https://explorer.lichess.org
+    - url: http://localhost:{port}
+      variables:
+        port:
+          default: "9002"
   security:
     - OAuth2: []
   parameters:

doc/specs/tags/openingexplorer/player.yaml

@@ -1,5 +1,3 @@
-servers:
-  - url: https://explorer.lichess.org
 get:
   operationId: openingExplorerPlayer
   summary: Player games
@@ -19,6 +17,12 @@ get:
     Example: `curl https://explorer.lichess.org/player?player=revoof&color=white&play=d2d4,d7d5&recentGames=1`
   tags:
     - Opening Explorer
+  servers:
+    - url: https://explorer.lichess.org
+    - url: http://localhost:{port}
+      variables:
+        port:
+          default: "9002"
   security:
     - OAuth2: []
   parameters:

doc/specs/tags/tablebase/antichess.yaml

@@ -1,12 +1,16 @@
-servers:
-  - url: https://tablebase.lichess.org
 get:
   operationId: antichessAtomic
   summary: Tablebase lookup for Antichess
   description: |
     **Endpoint: <https://tablebase.lichess.org>**
   tags:
     - Tablebase
+  servers:
+    - url: https://tablebase.lichess.org
+    - url: http://localhost:{port}
+      variables:
+        port:
+          default: "9000"
   security: []
   parameters:
     - in: query

doc/specs/tags/tablebase/atomic.yaml

@@ -1,12 +1,16 @@
-servers:
-  - url: https://tablebase.lichess.org
 get:
   operationId: tablebaseAtomic
   summary: Tablebase lookup for Atomic chess
   description: |
     **Endpoint: <https://tablebase.lichess.org>**
   tags:
     - Tablebase
+  servers:
+    - url: https://tablebase.lichess.org
+    - url: http://localhost:{port}
+      variables:
+        port:
+          default: "9000"
   security: []
   parameters:
     - in: query