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
|
// @Tags Event
|
||||||
// @Accept json
|
// @Accept json
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Param limit query string false "Maximum number of events to return (default 20)"
|
// @Param limit query int false "Maximum number of events to return (default 20)"
|
||||||
// @Param offset query string true "Number of events to skip"
|
// @Param offset query int false "Number of events to skip"
|
||||||
// @Param X-Api-Version header string true "latest"
|
// @Param X-Api-Version header string true "latest"
|
||||||
// @Success 200 {object} utils.RespStatus{data=[]data.EventIndexDoc} "Successful paginated list retrieval"
|
// @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)"
|
// @Failure 400 {object} utils.RespStatus{data=nil} "Invalid Input (Missing offset or malformed parameters)"
|
||||||
|
|||||||
@@ -1206,17 +1206,16 @@ const docTemplate = `{
|
|||||||
"summary": "List Events",
|
"summary": "List Events",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "integer",
|
||||||
"description": "Maximum number of events to return (default 20)",
|
"description": "Maximum number of events to return (default 20)",
|
||||||
"name": "limit",
|
"name": "limit",
|
||||||
"in": "query"
|
"in": "query"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "integer",
|
||||||
"description": "Number of events to skip",
|
"description": "Number of events to skip",
|
||||||
"name": "offset",
|
"name": "offset",
|
||||||
"in": "query",
|
"in": "query"
|
||||||
"required": true
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
|
|||||||
@@ -1204,17 +1204,16 @@
|
|||||||
"summary": "List Events",
|
"summary": "List Events",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "integer",
|
||||||
"description": "Maximum number of events to return (default 20)",
|
"description": "Maximum number of events to return (default 20)",
|
||||||
"name": "limit",
|
"name": "limit",
|
||||||
"in": "query"
|
"in": "query"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "integer",
|
||||||
"description": "Number of events to skip",
|
"description": "Number of events to skip",
|
||||||
"name": "offset",
|
"name": "offset",
|
||||||
"in": "query",
|
"in": "query"
|
||||||
"required": true
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
|
|||||||
@@ -861,12 +861,11 @@ paths:
|
|||||||
- description: Maximum number of events to return (default 20)
|
- description: Maximum number of events to return (default 20)
|
||||||
in: query
|
in: query
|
||||||
name: limit
|
name: limit
|
||||||
type: string
|
type: integer
|
||||||
- description: Number of events to skip
|
- description: Number of events to skip
|
||||||
in: query
|
in: query
|
||||||
name: offset
|
name: offset
|
||||||
required: true
|
type: integer
|
||||||
type: string
|
|
||||||
- description: latest
|
- description: latest
|
||||||
in: header
|
in: header
|
||||||
name: X-Api-Version
|
name: X-Api-Version
|
||||||
|
|||||||
Reference in New Issue
Block a user