From d633a6efff0c44d171f320a073d48792389e065e Mon Sep 17 00:00:00 2001 From: kolaente Date: Sun, 28 Feb 2021 19:08:52 +0100 Subject: [PATCH] Update swagger docs --- pkg/models/kanban.go | 3 +++ pkg/swagger/docs.go | 18 ++++++++++++++++++ pkg/swagger/swagger.json | 18 ++++++++++++++++++ pkg/swagger/swagger.yaml | 12 ++++++++++++ 4 files changed, 51 insertions(+) diff --git a/pkg/models/kanban.go b/pkg/models/kanban.go index e590b4682..4f192acdf 100644 --- a/pkg/models/kanban.go +++ b/pkg/models/kanban.go @@ -89,6 +89,9 @@ func getDefaultBucket(s *xorm.Session, listID int64) (bucket *Bucket, err error) // @Produce json // @Security JWTKeyAuth // @Param id path int true "List Id" +// @Param page query int false "The page number for tasks. Used for pagination. If not provided, the first page of results is returned." +// @Param per_page query int false "The maximum number of tasks per bucket per page. This parameter is limited by the configured maximum of items per page." +// @Param s query string false "Search tasks by task text." // @Param filter_by query string false "The name of the field to filter by. Allowed values are all task properties. Task properties which are their own object require passing in the id of that entity. Accepts an array for multiple filters which will be chanied together, all supplied filter must match." // @Param filter_value query string false "The value to filter for." // @Param filter_comparator query string false "The comparator to use for a filter. Available values are `equals`, `greater`, `greater_equals`, `less`, `less_equals`, `like` and `in`. `in` expects comma-separated values in `filter_value`. Defaults to `equals`" diff --git a/pkg/swagger/docs.go b/pkg/swagger/docs.go index 29f71362f..d2900bbb9 100644 --- a/pkg/swagger/docs.go +++ b/pkg/swagger/docs.go @@ -1223,6 +1223,24 @@ var doc = `{ "in": "path", "required": true }, + { + "type": "integer", + "description": "The page number for tasks. Used for pagination. If not provided, the first page of results is returned.", + "name": "page", + "in": "query" + }, + { + "type": "integer", + "description": "The maximum number of tasks per bucket per page. This parameter is limited by the configured maximum of items per page.", + "name": "per_page", + "in": "query" + }, + { + "type": "string", + "description": "Search tasks by task text.", + "name": "s", + "in": "query" + }, { "type": "string", "description": "The name of the field to filter by. Allowed values are all task properties. Task properties which are their own object require passing in the id of that entity. Accepts an array for multiple filters which will be chanied together, all supplied filter must match.", diff --git a/pkg/swagger/swagger.json b/pkg/swagger/swagger.json index 3137dac4d..79e53cb4d 100644 --- a/pkg/swagger/swagger.json +++ b/pkg/swagger/swagger.json @@ -1206,6 +1206,24 @@ "in": "path", "required": true }, + { + "type": "integer", + "description": "The page number for tasks. Used for pagination. If not provided, the first page of results is returned.", + "name": "page", + "in": "query" + }, + { + "type": "integer", + "description": "The maximum number of tasks per bucket per page. This parameter is limited by the configured maximum of items per page.", + "name": "per_page", + "in": "query" + }, + { + "type": "string", + "description": "Search tasks by task text.", + "name": "s", + "in": "query" + }, { "type": "string", "description": "The name of the field to filter by. Allowed values are all task properties. Task properties which are their own object require passing in the id of that entity. Accepts an array for multiple filters which will be chanied together, all supplied filter must match.", diff --git a/pkg/swagger/swagger.yaml b/pkg/swagger/swagger.yaml index 0df8e9df2..c63880094 100644 --- a/pkg/swagger/swagger.yaml +++ b/pkg/swagger/swagger.yaml @@ -1963,6 +1963,18 @@ paths: name: id required: true type: integer + - description: The page number for tasks. Used for pagination. If not provided, the first page of results is returned. + in: query + name: page + type: integer + - description: The maximum number of tasks per bucket per page. This parameter is limited by the configured maximum of items per page. + in: query + name: per_page + type: integer + - description: Search tasks by task text. + in: query + name: s + type: string - description: The name of the field to filter by. Allowed values are all task properties. Task properties which are their own object require passing in the id of that entity. Accepts an array for multiple filters which will be chanied together, all supplied filter must match. in: query name: filter_by