Merge pull request #626 from johndoknjas/update-pgn-moves-endpoint

Documentation for new endpoint to update a chapter's moves

Author: ornicar

doc/specs/lichess-api.yaml

@@ -475,6 +475,9 @@ paths:
   /api/study/{studyId}/{chapterId}/tags:
     $ref: "./tags/studies/api-study-studyId-chapterId-tags.yaml"
 
+  /api/study/{studyId}/{chapterId}/moves:
+    $ref: "./tags/studies/api-study-studyId-chapterId-moves.yaml"
+
   /api/study/by/{username}/export.pgn:
     $ref: "./tags/studies/api-study-by-username-export.pgn.yaml"
 

doc/specs/tags/studies/api-study-studyId-chapterId-moves.yaml

@@ -0,0 +1,55 @@
+post:
+  operationId: apiStudyChapterMoves
+  summary: Update the moves of a study chapter
+  description: |
+    Replaces the moves tree of a study chapter.
+    No tags will be modified.
+  tags:
+    - Studies
+  security:
+    - OAuth2: ["study:write"]
+  parameters:
+    - in: path
+      name: studyId
+      description: The study ID
+      required: true
+      schema:
+        type: string
+        minLength: 8
+        maxLength: 8
+    - in: path
+      name: chapterId
+      description: The chapter ID
+      required: true
+      schema:
+        type: string
+        minLength: 8
+        maxLength: 8
+  requestBody:
+    required: true
+    content:
+      application/x-www-form-urlencoded:
+        schema:
+          type: object
+          properties:
+            pgn:
+              type: string
+              description: |
+                PGN text containing the moves that will replace the chapter's existing moves.
+                Any provided tags are ignored.
+          required:
+            - pgn
+  responses:
+    "204":
+      description: Moves updated, as the chapter exists and you are allowed to edit it.
+      headers:
+        Access-Control-Allow-Origin:
+          schema:
+            type: string
+            default: "'*'"
+    "400":
+      description: Bad request - might be the provided study/chapter doesn't exist, or you aren't allowed to edit it, or the PGN is invalid.
+      content:
+        application/json:
+          schema:
+            $ref: "../../schemas/Error.yaml"

doc/specs/tags/studies/api-study-studyId-chapterId-tags.yaml

@@ -52,7 +52,7 @@ post:
             type: string
             default: "'*'"
     "400":
-      description: The creation of the chapter(s) failed.
+      description: The request body was invalid, such as missing or malformed PGN tag data.
       content:
         application/json:
           schema: