From a1cac494dc897cb11443663af508418ec58fdd37 Mon Sep 17 00:00:00 2001 From: Asai Neko Date: Thu, 5 Feb 2026 18:28:16 +0800 Subject: [PATCH] Mod swagger docs for event list api Signed-off-by: Asai Neko --- api/event/list.go | 4 ++-- docs/docs.go | 7 +++---- docs/swagger.json | 7 +++---- docs/swagger.yaml | 5 ++--- 4 files changed, 10 insertions(+), 13 deletions(-) diff --git a/api/event/list.go b/api/event/list.go index 1c7ee71..a9669a7 100644 --- a/api/event/list.go +++ b/api/event/list.go @@ -16,8 +16,8 @@ import ( // @Tags Event // @Accept json // @Produce json -// @Param limit query string false "Maximum number of events to return (default 20)" -// @Param offset query string true "Number of events to skip" +// @Param limit query int false "Maximum number of events to return (default 20)" +// @Param offset query int false "Number of events to skip" // @Param X-Api-Version header string true "latest" // @Success 200 {object} utils.RespStatus{data=[]data.EventIndexDoc} "Successful paginated list retrieval" // @Failure 400 {object} utils.RespStatus{data=nil} "Invalid Input (Missing offset or malformed parameters)" diff --git a/docs/docs.go b/docs/docs.go index 66eb775..88fb2d8 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -1206,17 +1206,16 @@ const docTemplate = `{ "summary": "List Events", "parameters": [ { - "type": "string", + "type": "integer", "description": "Maximum number of events to return (default 20)", "name": "limit", "in": "query" }, { - "type": "string", + "type": "integer", "description": "Number of events to skip", "name": "offset", - "in": "query", - "required": true + "in": "query" }, { "type": "string", diff --git a/docs/swagger.json b/docs/swagger.json index 87a28f5..2bb23c4 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -1204,17 +1204,16 @@ "summary": "List Events", "parameters": [ { - "type": "string", + "type": "integer", "description": "Maximum number of events to return (default 20)", "name": "limit", "in": "query" }, { - "type": "string", + "type": "integer", "description": "Number of events to skip", "name": "offset", - "in": "query", - "required": true + "in": "query" }, { "type": "string", diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 07a7e98..1bdf44b 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -861,12 +861,11 @@ paths: - description: Maximum number of events to return (default 20) in: query name: limit - type: string + type: integer - description: Number of events to skip in: query name: offset - required: true - type: string + type: integer - description: latest in: header name: X-Api-Version