chore(docs): add assignment creation request body to API doc (#432)

taikoxyz · Oct 19, 2023 · 8e6cc57 · 8e6cc57
1 parent 579dcc5
commit 8e6cc57
Show file tree

Hide file tree

Showing 4 changed files with 128 additions and 1 deletion.
diff --git a/docs/docs.go b/docs/docs.go
@@ -34,6 +34,17 @@ const docTemplate = `{
                 ],
                 "summary": "Try to accept a block proof assignment",
                 "operationId": "create-assignment",
+                "parameters": [
+                    {
+                        "description": "assignment request body",
+                        "name": "body",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/prover_server.CreateAssignmentRequestBody"
+                        }
+                    }
+                ],
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -72,6 +83,43 @@ const docTemplate = `{
         }
     },
     "definitions": {
+        "big.Int": {
+            "type": "object"
+        },
+        "github_com_taikoxyz_taiko-client_bindings_encoding.TierFee": {
+            "type": "object",
+            "properties": {
+                "fee": {
+                    "$ref": "#/definitions/big.Int"
+                },
+                "tier": {
+                    "type": "integer"
+                }
+            }
+        },
+        "prover_server.CreateAssignmentRequestBody": {
+            "type": "object",
+            "properties": {
+                "expiry": {
+                    "type": "integer"
+                },
+                "feeToken": {
+                    "type": "string"
+                },
+                "tierFees": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/github_com_taikoxyz_taiko-client_bindings_encoding.TierFee"
+                    }
+                },
+                "txListHash": {
+                    "type": "array",
+                    "items": {
+                        "type": "integer"
+                    }
+                }
+            }
+        },
         "prover_server.ProposeBlockResponse": {
             "type": "object",
             "properties": {

diff --git a/docs/swagger.json b/docs/swagger.json
@@ -25,6 +25,17 @@
                 ],
                 "summary": "Try to accept a block proof assignment",
                 "operationId": "create-assignment",
+                "parameters": [
+                    {
+                        "description": "assignment request body",
+                        "name": "body",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/prover_server.CreateAssignmentRequestBody"
+                        }
+                    }
+                ],
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -63,6 +74,43 @@
         }
     },
     "definitions": {
+        "big.Int": {
+            "type": "object"
+        },
+        "github_com_taikoxyz_taiko-client_bindings_encoding.TierFee": {
+            "type": "object",
+            "properties": {
+                "fee": {
+                    "$ref": "#/definitions/big.Int"
+                },
+                "tier": {
+                    "type": "integer"
+                }
+            }
+        },
+        "prover_server.CreateAssignmentRequestBody": {
+            "type": "object",
+            "properties": {
+                "expiry": {
+                    "type": "integer"
+                },
+                "feeToken": {
+                    "type": "string"
+                },
+                "tierFees": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/github_com_taikoxyz_taiko-client_bindings_encoding.TierFee"
+                    }
+                },
+                "txListHash": {
+                    "type": "array",
+                    "items": {
+                        "type": "integer"
+                    }
+                }
+            }
+        },
         "prover_server.ProposeBlockResponse": {
             "type": "object",
             "properties": {

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -1,4 +1,28 @@
 definitions:
+  big.Int:
+    type: object
+  github_com_taikoxyz_taiko-client_bindings_encoding.TierFee:
+    properties:
+      fee:
+        $ref: '#/definitions/big.Int'
+      tier:
+        type: integer
+    type: object
+  prover_server.CreateAssignmentRequestBody:
+    properties:
+      expiry:
+        type: integer
+      feeToken:
+        type: string
+      tierFees:
+        items:
+          $ref: '#/definitions/github_com_taikoxyz_taiko-client_bindings_encoding.TierFee'
+        type: array
+      txListHash:
+        items:
+          type: integer
+        type: array
+    type: object
   prover_server.ProposeBlockResponse:
     properties:
       prover:
@@ -38,6 +62,13 @@ paths:
       consumes:
       - application/json
       operationId: create-assignment
+      parameters:
+      - description: assignment request body
+        in: body
+        name: body
+        required: true
+        schema:
+          $ref: '#/definitions/prover_server.CreateAssignmentRequestBody'
       produces:
       - application/json
       responses:

diff --git a/prover/server/api.go b/prover/server/api.go
@@ -71,7 +71,7 @@ type ProposeBlockResponse struct {
 // can submit onchain.
 //
 //	@Summary		Try to accept a block proof assignment
-//	@ID			   	create-assignment
+//	@Param          body        body    CreateAssignmentRequestBody   true    "assignment request body"
 //	@Accept			json
 //	@Produce		json
 //	@Success		200		{object} ProposeBlockResponse