fix(docs): update swagger github action (#761)

taikoxyz · Apr 25, 2024 · 48f2b27 · 48f2b27
1 parent 4c60ce1
commit 48f2b27
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 60 deletions.
diff --git a/.swaggo b/.swaggo
@@ -1 +1,2 @@
 replace common.Address string
+replace encoding.TierFee uint64
diff --git a/docs/docs.go b/docs/docs.go
@@ -82,36 +82,25 @@ const docTemplate = `{
         }
     },
     "definitions": {
-        "big.Int": {
-            "type": "object"
-        },
-        "encoding.TierFee": {
-            "type": "object",
-            "properties": {
-                "fee": {
-                    "$ref": "#/definitions/big.Int"
-                },
-                "tier": {
-                    "type": "integer"
-                }
-            }
-        },
         "server.CreateAssignmentRequestBody": {
             "type": "object",
             "properties": {
+                "blobHash": {
+                    "type": "array",
+                    "items": {
+                        "type": "integer"
+                    }
+                },
                 "expiry": {
                     "type": "integer"
                 },
                 "feeToken": {
                     "type": "string"
                 },
-                "tierFees": {
-                    "type": "array",
-                    "items": {
-                        "$ref": "#/definitions/encoding.TierFee"
-                    }
+                "proposer": {
+                    "type": "string"
                 },
-                "txListHash": {
+                "tierFees": {
                     "type": "array",
                     "items": {
                         "type": "integer"
@@ -148,6 +137,9 @@ const docTemplate = `{
                 "minOptimisticTierFee": {
                     "type": "integer"
                 },
+                "minSgxAndZkVMTierFee": {
+                    "type": "integer"
+                },
                 "minSgxTierFee": {
                     "type": "integer"
                 },

diff --git a/docs/swagger.json b/docs/swagger.json
@@ -73,36 +73,25 @@
         }
     },
     "definitions": {
-        "big.Int": {
-            "type": "object"
-        },
-        "encoding.TierFee": {
-            "type": "object",
-            "properties": {
-                "fee": {
-                    "$ref": "#/definitions/big.Int"
-                },
-                "tier": {
-                    "type": "integer"
-                }
-            }
-        },
         "server.CreateAssignmentRequestBody": {
             "type": "object",
             "properties": {
+                "blobHash": {
+                    "type": "array",
+                    "items": {
+                        "type": "integer"
+                    }
+                },
                 "expiry": {
                     "type": "integer"
                 },
                 "feeToken": {
                     "type": "string"
                 },
-                "tierFees": {
-                    "type": "array",
-                    "items": {
-                        "$ref": "#/definitions/encoding.TierFee"
-                    }
+                "proposer": {
+                    "type": "string"
                 },
-                "txListHash": {
+                "tierFees": {
                     "type": "array",
                     "items": {
                         "type": "integer"
@@ -139,6 +128,9 @@
                 "minOptimisticTierFee": {
                     "type": "integer"
                 },
+                "minSgxAndZkVMTierFee": {
+                    "type": "integer"
+                },
                 "minSgxTierFee": {
                     "type": "integer"
                 },

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -1,24 +1,17 @@
 definitions:
-  big.Int:
-    type: object
-  encoding.TierFee:
-    properties:
-      fee:
-        $ref: '#/definitions/big.Int'
-      tier:
-        type: integer
-    type: object
   server.CreateAssignmentRequestBody:
     properties:
+      blobHash:
+        items:
+          type: integer
+        type: array
       expiry:
         type: integer
       feeToken:
         type: string
+      proposer:
+        type: string
       tierFees:
-        items:
-          $ref: '#/definitions/encoding.TierFee'
-        type: array
-      txListHash:
         items:
           type: integer
         type: array
@@ -42,6 +35,8 @@ definitions:
         type: integer
       minOptimisticTierFee:
         type: integer
+      minSgxAndZkVMTierFee:
+        type: integer
       minSgxTierFee:
         type: integer
       prover:

diff --git a/index.html b/index.html
@@ -11,7 +11,7 @@
             window.onload = function () {
                 // Begin Swagger UI call region
                 const ui = SwaggerUIBundle({
-                    url: "docs/swagger.json", //Location of Open API spec in the repo
+                    url: "./docs/swagger.json", //Location of Open API spec in the repo
                     dom_id: '#swagger-ui',
                     deepLinking: true,
                     presets: [

diff --git a/prover/server/api.go b/prover/server/api.go
@@ -34,11 +34,11 @@ const (
 
 // CreateAssignmentRequestBody represents a request body when handling assignment creation request.
 type CreateAssignmentRequestBody struct {
-	Proposer common.Address
-	FeeToken common.Address
-	TierFees []encoding.TierFee
-	Expiry   uint64
-	BlobHash common.Hash
+	Proposer common.Address     `json:"proposer"`
+	FeeToken common.Address     `json:"feeToken"`
+	TierFees []encoding.TierFee `json:"tierFees"`
+	Expiry   uint64             `json:"expiry"`
+	BlobHash common.Hash        `json:"blobHash"`
 }
 
 // Status represents the current prover server status.
@@ -82,7 +82,7 @@ type ProposeBlockResponse struct {
 // can submit onchain.
 //
 //	@Summary		Try to accept a block proof assignment
-//	@Param          	body            CreateAssignmentRequestBody   true    "assignment request body"
+//	@Param          body	body	server.CreateAssignmentRequestBody   true    "assignment request body"
 //	@Accept			json
 //	@Produce		json
 //	@Success		200		{object} ProposeBlockResponse