refactor and update required data to create and update a broadcast

lichess-org · Nov 3, 2023 · 8db9efa · 8db9efa
1 parent 2d6ede6
commit 8db9efa
Showing 1 changed file with 50 additions and 46 deletions.
diff --git a/doc/specs/lichess-api.yaml b/doc/specs/lichess-api.yaml
@@ -3978,29 +3978,7 @@ paths:
         content:
           application/x-www-form-urlencoded:
             schema:
-              type: object
-              properties:
-                name:
-                  type: string
-                  description: |
-                    Name of the broadcast tournament. Length must be between 3 and 80 characters.
-
-                    Example: `Sinquefield Cup`
-                description:
-                  type: string
-                  description: |
-                    Short description of the broadcast tournament. Length must be between 3 and 400 characters.
-
-                    Example: `An 11 round classical tournament featuring the 9 highest rated players in the world. Including Carlsen, Caruana, Ding, Aronian, Nakamura and more.`
-                markdown:
-                  type: string
-                  description: Optional long description of the broadcast. Markdown is supported. Length must be less than 20,000 characters.
-                official:
-                  type: boolean
-                  description: For Lichess internal usage only. You are not allowed to use this flag. If you do it, we will have to call the police.
-              required:
-                - name
-                - description
+              $ref: '#/components/schemas/BroadcastForm'
       responses:
         "200":
           description: The broadcast tournament was successfully created.
@@ -4075,29 +4053,7 @@ paths:
           content:
             application/x-www-form-urlencoded:
               schema:
-                type: object
-                properties:
-                  name:
-                    type: string
-                    description: |
-                      Name of the broadcast tournament. Length must be between 3 and 80 characters.
-
-                      Example: `Sinquefield Cup`
-                  description:
-                    type: string
-                    description: |
-                      Short description of the broadcast tournament. Length must be between 3 and 400 characters.
-
-                      Example: `An 11 round classical tournament featuring the 9 highest rated players in the world. Including Carlsen, Caruana, Ding, Aronian, Nakamura and more.`
-                  markdown:
-                    type: string
-                    description: Optional long description of the broadcast tournament. Markdown is supported. Length must be less than 20,000 characters.
-                  official:
-                    type: boolean
-                    description: For Lichess internal usage only. You are not allowed to use this flag. If you do it, we will have to call the police.
-                required:
-                  - name
-                  - description
+                $ref: '#/components/schemas/BroadcastForm'
         responses:
           "200":
             description: The broadcast tournament was successfully edited.
@@ -9889,6 +9845,54 @@ components:
           ]
       }
 
+    BroadcastForm:
+      type: object
+      properties:
+        name:
+          type: string
+          description: |
+            Name of the broadcast tournament. Length must be between 3 and 80 characters.
+
+            Example: `Sinquefield Cup`
+        description:
+          type: string
+          description: |
+            Short description of the broadcast tournament. Length must be between 3 and 400 characters.
+
+            Example: `An 11 round classical tournament featuring the 9 highest rated players in the world. Including Carlsen, Caruana, Ding, Aronian, Nakamura and more.`
+        autoLeaderboard:
+          type: boolean
+          description: Compute and display a simple leaderboard based on game results
+        markdown:
+          type: string
+          description: Optional long description of the broadcast. Markdown is supported. Length must be less than 20,000 characters.
+        tier:
+          type: integer
+          description: |
+            Optional, for Lichess admins only, use to feature on /broadcast. 
+            
+            * `3` for normal
+            * `4` for high
+            * `5` for best
+        players:
+          description: |
+            Optional replace player names, ratings and titles.
+
+            One line per player, formatted as such:
+            
+            `Original name; Replacement name; Optional replacement rating; Optional replacement title`
+
+            Example:
+            
+            DrNykterstein;Magnus Carlsen;2863
+            
+            AnishGiri;Anish Giri;2764;GM
+      required:
+        - name
+        - description
+        - autoLeaderboard
+
+
     BroadcastTour:
       example: {
         "tour": {