Merge pull request #305 from allanjoseph98/division

Document game export `division` parameter
lichess-org · Jan 26, 2024 · e62d4b1 · e62d4b1
2 parents f83773b + 8fc00da
commit e62d4b1
Showing 1 changed file with 58 additions and 0 deletions.
diff --git a/doc/specs/lichess-api.yaml b/doc/specs/lichess-api.yaml
@@ -1020,6 +1020,14 @@ paths:
           schema:
             type: boolean
             default: true
+        - in: query
+          name: division
+          description: | 
+            Plies which mark the beginning of the middlegame and endgame.
+            Only available in JSON
+          schema:
+            type: boolean
+            default: true
         - in: query
           name: literate
           description: |
@@ -1126,6 +1134,14 @@ paths:
           schema:
             type: boolean
             default: true
+        - in: query
+          name: division
+          description: | 
+            Plies which mark the beginning of the middlegame and endgame.
+            Only available in JSON
+          schema:
+            type: boolean
+            default: false
         - in: query
           name: literate
           description: |
@@ -1294,6 +1310,14 @@ paths:
           schema:
             type: boolean
             default: false
+        - in: query
+          name: division
+          description: | 
+            Plies which mark the beginning of the middlegame and endgame.
+            Only available in JSON
+          schema:
+            type: boolean
+            default: false
         - in: query
           name: ongoing
           description: Ongoing games are delayed by a few seconds ranging from 3 to 60 depending on the time control, as to prevent cheat bots from using this API.
@@ -1438,6 +1462,14 @@ paths:
           schema:
             type: boolean
             default: false
+        - in: query
+          name: division
+          description: | 
+            Plies which mark the beginning of the middlegame and endgame.
+            Only available in JSON
+          schema:
+            type: boolean
+            default: false
         - in: query
           name: literate
           description: |
@@ -2636,6 +2668,14 @@ paths:
           schema:
             type: boolean
             default: false
+        - in: query
+          name: division
+          description: | 
+            Plies which mark the beginning of the middlegame and endgame.
+            Only available in JSON
+          schema:
+            type: boolean
+            default: false
       responses:
         "200":
           description: The list of games of an Arena tournament.
@@ -3536,6 +3576,14 @@ paths:
           schema:
             type: boolean
             default: false
+        - in: query
+          name: division
+          description: | 
+            Plies which mark the beginning of the middlegame and endgame.
+            Only available in JSON
+          schema:
+            type: boolean
+            default: false
       responses:
         "200":
           description: The list of games of a Swiss tournament.
@@ -8742,6 +8790,16 @@ components:
               type: number
             totalTime:
               type: number
+        division:
+          type: object
+          properties:
+            middle:
+              type: number
+              description: Ply at which the middlegame begins
+            end:
+              type: number
+              description: Ply at which the endgame begins
+          required: []
       required:
         - id
         - rated