Mod swagger docs for event list api
Signed-off-by: Asai Neko <sugar@sne.moe>
This commit is contained in:
@@ -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)"
|
||||
|
||||
@@ -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",
|
||||
|
||||
@@ -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",
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user