add swagger

optimism-java · Jul 25, 2024 · f32f467 · f32f467
1 parent 367c0c0
commit f32f467
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 4 deletions.
diff --git a/docs/docs.go b/docs/docs.go
@@ -120,7 +120,7 @@ const docTemplate = `{
                         "schema": {
                             "type": "array",
                             "items": {
-                                "$ref": "#/definitions/api.AmountPerDay"
+                                "$ref": "#/definitions/api.CountGames"
                             }
                         }
                     }
@@ -239,6 +239,20 @@ const docTemplate = `{
                 }
             }
         },
+        "api.CountGames": {
+            "type": "object",
+            "properties": {
+                "amount": {
+                    "type": "string"
+                },
+                "date": {
+                    "type": "string"
+                },
+                "status": {
+                    "type": "string"
+                }
+            }
+        },
         "api.Overview": {
             "type": "object",
             "properties": {

diff --git a/docs/swagger.json b/docs/swagger.json
@@ -109,7 +109,7 @@
                         "schema": {
                             "type": "array",
                             "items": {
-                                "$ref": "#/definitions/api.AmountPerDay"
+                                "$ref": "#/definitions/api.CountGames"
                             }
                         }
                     }
@@ -228,6 +228,20 @@
                 }
             }
         },
+        "api.CountGames": {
+            "type": "object",
+            "properties": {
+                "amount": {
+                    "type": "string"
+                },
+                "date": {
+                    "type": "string"
+                },
+                "status": {
+                    "type": "string"
+                }
+            }
+        },
         "api.Overview": {
             "type": "object",
             "properties": {

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -6,6 +6,15 @@ definitions:
       date:
         type: string
     type: object
+  api.CountGames:
+    properties:
+      amount:
+        type: string
+      date:
+        type: string
+      status:
+        type: string
+    type: object
   api.Overview:
     properties:
       challengerWinGamesCount:
@@ -93,7 +102,7 @@ paths:
           description: OK
           schema:
             items:
-              $ref: '#/definitions/api.AmountPerDay'
+              $ref: '#/definitions/api.CountGames'
             type: array
       summary: GetCountDisputeGameGroupByStatus
   /disputegames/credit/rank:

diff --git a/internal/api/dispute_game_handler.go b/internal/api/dispute_game_handler.go
@@ -211,7 +211,7 @@ type CountGames struct {
 // @Accept			json
 // @Produce		json
 // @Param			days	query		int	false	"today before ? days"
-// @Success		200		{object}	[]AmountPerDay
+// @Success		200		{object}	[]CountGames
 // @Router			/disputegames/count [get]
 func (h DisputeGameHandler) GetCountDisputeGameGroupByStatus(c *gin.Context) {
 	days := cast.ToInt(c.Query("days"))