docs(repo): update swagger scripts and api docs for relayer and event…

…indexer (#15755) Co-authored-by: d1onys1us <[email protected]>
taikoxyz · Feb 14, 2024 · a19922d · a19922d
1 parent 365b604
commit a19922d
Show file tree

Hide file tree

Showing 14 changed files with 648 additions and 482 deletions.
diff --git a/packages/eventindexer/docs/docs.go b/packages/eventindexer/docs/docs.go
@@ -1,4 +1,4 @@
-// Code generated by swaggo/swag. DO NOT EDIT
+// Package docs Code generated by swaggo/swag. DO NOT EDIT
 package docs
 
 import "github.com/swaggo/swag"
@@ -52,6 +52,35 @@ const docTemplate = `{
                 }
             }
         },
+        "/chartByTask": {
+            "get": {
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "summary": "Get time series data for displaying charts",
+                "operationId": "get-charts-by-task",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "task to query",
+                        "name": "task",
+                        "in": "query",
+                        "required": true
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/eventindexer.ChartResponse"
+                        }
+                    }
+                }
+            }
+        },
         "/events": {
             "get": {
                 "consumes": [
@@ -186,6 +215,28 @@ const docTemplate = `{
         }
     },
     "definitions": {
+        "eventindexer.ChartItem": {
+            "type": "object",
+            "properties": {
+                "date": {
+                    "type": "string"
+                },
+                "value": {
+                    "type": "string"
+                }
+            }
+        },
+        "eventindexer.ChartResponse": {
+            "type": "object",
+            "properties": {
+                "chart": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/eventindexer.ChartItem"
+                    }
+                }
+            }
+        },
         "eventindexer.Stat": {
             "type": "object",
             "properties": {
@@ -195,20 +246,20 @@ const docTemplate = `{
                 "averageProofTime": {
                     "type": "string"
                 },
-                "averageProposerReward": {
+                "feeTokenAddress": {
                     "type": "string"
                 },
                 "id": {
                     "type": "integer"
                 },
-                "numProofs": {
+                "numBlocksAssigned": {
                     "type": "integer"
                 },
-                "numProposerRewards": {
+                "numProofs": {
                     "type": "integer"
                 },
-                "numVerifiedBlocks": {
-                    "type": "integer"
+                "statType": {
+                    "type": "string"
                 }
             }
         },
@@ -298,13 +349,15 @@ const docTemplate = `{
 // SwaggerInfo holds exported Swagger Info so clients can modify it
 var SwaggerInfo = &swag.Spec{
 	Version:          "1.0",
-	Host:             "eventindexer.jolnir.taiko.xyz",
+	Host:             "eventindexer.katla.taiko.xyz",
 	BasePath:         "",
 	Schemes:          []string{},
 	Title:            "Taiko Eventindexer API",
 	Description:      "",
 	InfoInstanceName: "swagger",
 	SwaggerTemplate:  docTemplate,
+	LeftDelim:        "{{",
+	RightDelim:       "}}",
 }
 
 func init() {

diff --git a/packages/eventindexer/docs/index.html b/packages/eventindexer/docs/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: "/swagger.json", //Location of Open API spec in the repo
                     dom_id: '#swagger-ui',
                     deepLinking: true,
                     presets: [