Add history action removal API documentation (#366)

gristlabs · Jul 23, 2024 · fc5ff60 · fc5ff60
1 parent a1af19b
commit fc5ff60
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 28 deletions.
diff --git a/api/grist.yml b/api/grist.yml
@@ -443,6 +443,27 @@ paths:
             text/json:
               schema:
                 $ref: '#/components/schemas/TableSchemaResult'
+  /docs/{docId}/states/remove:
+    post:
+      operationId: deleteActions
+      tags:
+        - docs
+      summary: "Truncate the document's action history"
+      parameters:
+        - $ref: '#/components/parameters/docIdPathParam'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+                - keep
+              properties:
+                keep:
+                  type: integer
+                  description: "The number of the latest history actions to keep"
+              example:
+                keep: 3
   /docs/{docId}/force-reload:
     post:
       operationId: forceReload