vikunja/vikunja
8
54
Fork 94
Code Issues 101 Pull Requests 31 Packages Releases 37 Activity
vikunja/pkg/swagger/docs.go

9011 lines
335 KiB
Go
Raw Normal View History

[skip ci] Updated swagger docs
2023-10-11 08:50:34 +00:00
// Package swagger Code generated by swaggo/swag. DO NOT EDIT
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
package swagger
import "github.com/swaggo/swag"
const docTemplate = `{
"schemes": {{ marshal .Schemes }},
"swagger": "2.0",
"info": {
"description": "{{escape .Description}}",
"title": "{{.Title}}",
"contact": {
"name": "General Vikunja contact",
"url": "https://vikunja.io/contact/",
"email": "hello@vikunja.io"
},
"license": {
"name": "AGPL-3.0-or-later",
"url": "https://code.vikunja.io/api/src/branch/main/LICENSE"
},
"version": "{{.Version}}"
},
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
"/auth/openid/{provider}/callback": {
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "After a redirect from the OpenID Connect provider to the frontend has been made with the authentication ` + "`" + `code` + "`" + `, this endpoint can be used to obtain a jwt token for that user and thus log them in.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"auth"
],
"summary": "Authenticate a user with OpenID Connect",
"operationId": "get-token-openid",
"parameters": [
{
"description": "The openid callback",
"name": "callback",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openid.Callback"
}
},
{
"type": "integer",
"description": "The OpenID Connect provider key as returned by the /info endpoint",
"name": "provider",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/auth.Token"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/backgrounds/unsplash/image/{image}": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Get an unsplash image. **Returns json on error.**",
"produces": [
"application/octet-stream"
],
"tags": [
"project"
],
"summary": "Get an unsplash image",
"parameters": [
{
"type": "integer",
"description": "Unsplash Image ID",
"name": "image",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The image",
"schema": {
"type": "file"
}
},
"404": {
"description": "The image does not exist.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/backgrounds/unsplash/image/{image}/thumb": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Get an unsplash thumbnail image. The thumbnail is cropped to a max width of 200px. **Returns json on error.**",
"produces": [
"application/octet-stream"
],
"tags": [
"project"
],
"summary": "Get an unsplash thumbnail image",
"parameters": [
{
"type": "integer",
"description": "Unsplash Image ID",
"name": "image",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The thumbnail",
"schema": {
"type": "file"
}
},
"404": {
"description": "The image does not exist.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/backgrounds/unsplash/search": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Search for a project background from unsplash",
"produces": [
"application/json"
],
"tags": [
"project"
],
"summary": "Search for a background from unsplash",
"parameters": [
{
"type": "string",
"description": "Search backgrounds from unsplash with this search term.",
"name": "s",
"in": "query"
},
{
"type": "integer",
"description": "The page number. Used for pagination. If not provided, the first page of results is returned.",
"name": "p",
"in": "query"
}
],
"responses": {
"200": {
"description": "An array with photos",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/background.Image"
}
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/filters": {
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Creates a new saved filter",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"filter"
],
"summary": "Creates a new saved filter",
"responses": {
"201": {
"description": "The Saved Filter",
"schema": {
"$ref": "#/definitions/models.SavedFilter"
}
},
"403": {
"description": "The user does not have access to that saved filter.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/filters/{id}": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns a saved filter by its ID.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"filter"
],
"summary": "Gets one saved filter",
"parameters": [
{
"type": "integer",
"description": "Filter ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The Saved Filter",
"schema": {
"$ref": "#/definitions/models.SavedFilter"
}
},
"403": {
"description": "The user does not have access to that saved filter.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Updates a saved filter by its ID.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"filter"
],
"summary": "Updates a saved filter",
"parameters": [
{
"type": "integer",
"description": "Filter ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The Saved Filter",
"schema": {
"$ref": "#/definitions/models.SavedFilter"
}
},
"403": {
"description": "The user does not have access to that saved filter.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "The saved filter does not exist.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"delete": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Removes a saved filter by its ID.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"filter"
],
"summary": "Removes a saved filter",
"parameters": [
{
"type": "integer",
"description": "Filter ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The Saved Filter",
"schema": {
"$ref": "#/definitions/models.SavedFilter"
}
},
"403": {
"description": "The user does not have access to that saved filter.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "The saved filter does not exist.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/info": {
"get": {
"description": "Returns the version, frontendurl, motd and various settings of Vikunja",
"produces": [
"application/json"
],
"tags": [
"service"
],
"summary": "Info",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/v1.vikunjaInfos"
}
}
}
}
},
"/labels": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns all labels which are either created by the user or associated with a task the user has at least read-access to.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"labels"
],
"summary": "Get all labels a user has access to",
"parameters": [
{
"type": "integer",
"description": "The page number. Used for pagination. If not provided, the first page of results is returned.",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.",
"name": "per_page",
"in": "query"
},
{
"type": "string",
"description": "Search labels by label text.",
"name": "s",
"in": "query"
}
],
"responses": {
"200": {
"description": "The labels",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.Label"
}
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Creates a new label.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"labels"
],
"summary": "Create a label",
"parameters": [
{
"description": "The label object",
"name": "label",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.Label"
}
}
],
"responses": {
"201": {
"description": "The created label object.",
"schema": {
"$ref": "#/definitions/models.Label"
}
},
"400": {
"description": "Invalid label object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/labels/{id}": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns one label by its ID.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"labels"
],
"summary": "Gets one label",
"parameters": [
{
"type": "integer",
"description": "Label ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The label",
"schema": {
"$ref": "#/definitions/models.Label"
}
},
"403": {
"description": "The user does not have access to the label",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "Label not found",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Update an existing label. The user needs to be the creator of the label to be able to do this.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"labels"
],
"summary": "Update a label",
"parameters": [
{
"type": "integer",
"description": "Label ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "The label object",
"name": "label",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.Label"
}
}
],
"responses": {
"200": {
"description": "The created label object.",
"schema": {
"$ref": "#/definitions/models.Label"
}
},
"400": {
"description": "Invalid label object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"403": {
"description": "Not allowed to update the label.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "Label not found.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"delete": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Delete an existing label. The user needs to be the creator of the label to be able to do this.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"labels"
],
"summary": "Delete a label",
"parameters": [
{
"type": "integer",
"description": "Label ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The label was successfully deleted.",
"schema": {
"$ref": "#/definitions/models.Label"
}
},
"403": {
"description": "Not allowed to delete the label.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "Label not found.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/login": {
"post": {
"description": "Logs a user in. Returns a JWT-Token to authenticate further requests.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"auth"
],
"summary": "Login",
"parameters": [
{
"description": "The login credentials",
"name": "credentials",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/user.Login"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/auth.Token"
}
},
"400": {
"description": "Invalid user password model.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"403": {
"description": "Invalid username or password.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"412": {
"description": "Invalid totp passcode.",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/migration/microsoft-todo/auth": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns the auth url where the user needs to get its auth code. This code can then be used to migrate everything from Microsoft Todo to Vikunja.",
"produces": [
"application/json"
],
"tags": [
"migration"
],
"summary": "Get the auth url from Microsoft Todo",
"responses": {
"200": {
"description": "The auth url.",
"schema": {
"$ref": "#/definitions/handler.AuthURL"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/migration/microsoft-todo/migrate": {
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Migrates all tasklinsts, tasks, notes and reminders from Microsoft Todo to Vikunja.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"migration"
],
"summary": "Migrate all projects, tasks etc. from Microsoft Todo",
"parameters": [
{
"description": "The auth token previously obtained from the auth url. See the docs for /migration/microsoft-todo/auth.",
"name": "migrationCode",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/microsofttodo.Migration"
}
}
],
"responses": {
"200": {
"description": "A message telling you everything was migrated successfully.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/migration/microsoft-todo/status": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns if the current user already did the migation or not. This is useful to show a confirmation message in the frontend if the user is trying to do the same migration again.",
"produces": [
"application/json"
],
"tags": [
"migration"
],
"summary": "Get migration status",
"responses": {
"200": {
"description": "The migration status",
"schema": {
"$ref": "#/definitions/migration.Status"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/migration/ticktick/migrate": {
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Imports all projects, tasks, notes, reminders, subtasks and files from a TickTick backup export into Vikunja.",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json"
],
"tags": [
"migration"
],
"summary": "Import all projects, tasks etc. from a TickTick backup export",
"parameters": [
{
"type": "string",
"description": "The TickTick backup csv file.",
"name": "import",
"in": "formData",
"required": true
}
],
"responses": {
"200": {
"description": "A message telling you everything was migrated successfully.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/migration/ticktick/status": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns if the current user already did the migation or not. This is useful to show a confirmation message in the frontend if the user is trying to do the same migration again.",
"produces": [
"application/json"
],
"tags": [
"migration"
],
"summary": "Get migration status",
"responses": {
"200": {
"description": "The migration status",
"schema": {
"$ref": "#/definitions/migration.Status"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/migration/todoist/auth": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns the auth url where the user needs to get its auth code. This code can then be used to migrate everything from todoist to Vikunja.",
"produces": [
"application/json"
],
"tags": [
"migration"
],
"summary": "Get the auth url from todoist",
"responses": {
"200": {
"description": "The auth url.",
"schema": {
"$ref": "#/definitions/handler.AuthURL"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/migration/todoist/migrate": {
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Migrates all projects, tasks, notes, reminders, subtasks and files from todoist to vikunja.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"migration"
],
"summary": "Migrate all lists, tasks etc. from todoist",
"parameters": [
{
"description": "The auth code previously obtained from the auth url. See the docs for /migration/todoist/auth.",
"name": "migrationCode",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/todoist.Migration"
}
}
],
"responses": {
"200": {
"description": "A message telling you everything was migrated successfully.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/migration/todoist/status": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns if the current user already did the migation or not. This is useful to show a confirmation message in the frontend if the user is trying to do the same migration again.",
"produces": [
"application/json"
],
"tags": [
"migration"
],
"summary": "Get migration status",
"responses": {
"200": {
"description": "The migration status",
"schema": {
"$ref": "#/definitions/migration.Status"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/migration/trello/auth": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns the auth url where the user needs to get its auth code. This code can then be used to migrate everything from trello to Vikunja.",
"produces": [
"application/json"
],
"tags": [
"migration"
],
"summary": "Get the auth url from trello",
"responses": {
"200": {
"description": "The auth url.",
"schema": {
"$ref": "#/definitions/handler.AuthURL"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/migration/trello/migrate": {
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Migrates all projects, tasks, notes, reminders, subtasks and files from trello to vikunja.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"migration"
],
"summary": "Migrate all projects, tasks etc. from trello",
"parameters": [
{
"description": "The auth token previously obtained from the auth url. See the docs for /migration/trello/auth.",
"name": "migrationCode",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/trello.Migration"
}
}
],
"responses": {
"200": {
"description": "A message telling you everything was migrated successfully.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/migration/trello/status": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns if the current user already did the migation or not. This is useful to show a confirmation message in the frontend if the user is trying to do the same migration again.",
"produces": [
"application/json"
],
"tags": [
"migration"
],
"summary": "Get migration status",
"responses": {
"200": {
"description": "The migration status",
"schema": {
"$ref": "#/definitions/migration.Status"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/migration/vikunja-file/migrate": {
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Imports all projects, tasks, notes, reminders, subtasks and files from a Vikunjda data export into Vikunja.",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json"
],
"tags": [
"migration"
],
"summary": "Import all projects, tasks etc. from a Vikunja data export",
"parameters": [
{
"type": "string",
"description": "The Vikunja export zip file.",
"name": "import",
"in": "formData",
"required": true
}
],
"responses": {
"200": {
"description": "A message telling you everything was migrated successfully.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/migration/vikunja-file/status": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns if the current user already did the migation or not. This is useful to show a confirmation message in the frontend if the user is trying to do the same migration again.",
"produces": [
"application/json"
],
"tags": [
"migration"
],
"summary": "Get migration status",
"responses": {
"200": {
"description": "The migration status",
"schema": {
"$ref": "#/definitions/migration.Status"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/notifications": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns an array with all notifications for the current user.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"subscriptions"
],
"summary": "Get all notifications for the current user",
"parameters": [
{
"type": "integer",
"description": "The page number. Used for pagination. If not provided, the first page of results is returned.",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.",
"name": "per_page",
"in": "query"
}
],
"responses": {
"200": {
"description": "The notifications",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/notifications.DatabaseNotification"
}
}
},
"403": {
"description": "Link shares cannot have notifications.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
[skip ci] Updated swagger docs
2023-10-22 17:21:16 +00:00
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"sharing"
],
"summary": "Mark all notifications of a user as read",
"responses": {
"200": {
"description": "All notifications marked as read.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
}
},
"/notifications/{id}": {
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Marks a notification as either read or unread. A user can only mark their own notifications as read.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"subscriptions"
],
"summary": "Mark a notification as (un-)read",
"parameters": [
{
"type": "integer",
"description": "Notification ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The notification to mark as read.",
"schema": {
"$ref": "#/definitions/models.DatabaseNotifications"
}
},
"403": {
"description": "Link shares cannot have notifications.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "The notification does not exist.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/projects": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns all projects a user has access to.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"project"
],
"summary": "Get all projects a user has access to",
"parameters": [
{
"type": "integer",
"description": "The page number. Used for pagination. If not provided, the first page of results is returned.",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.",
"name": "per_page",
"in": "query"
},
{
"type": "string",
"description": "Search projects by title.",
"name": "s",
"in": "query"
},
{
"type": "boolean",
"description": "If true, also returns all archived projects.",
"name": "is_archived",
"in": "query"
}
],
"responses": {
"200": {
"description": "The projects",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.Project"
}
}
},
"403": {
"description": "The user does not have access to the project",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Creates a new project. If a parent project is provided the user needs to have write access to that project.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"project"
],
"summary": "Creates a new project",
"parameters": [
{
"description": "The project you want to create.",
"name": "project",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.Project"
}
}
],
"responses": {
"201": {
"description": "The created project.",
"schema": {
"$ref": "#/definitions/models.Project"
}
},
"400": {
"description": "Invalid project object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"403": {
"description": "The user does not have access to the project",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/projects/{id}": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns a project by its ID.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"project"
],
"summary": "Gets one project",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The project",
"schema": {
"$ref": "#/definitions/models.Project"
}
},
"403": {
"description": "The user does not have access to the project",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Updates a project. This does not include adding a task (see below).",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"project"
],
"summary": "Updates a project",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "The project with updated values you want to update.",
"name": "project",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.Project"
}
}
],
"responses": {
"200": {
"description": "The updated project.",
"schema": {
"$ref": "#/definitions/models.Project"
}
},
"400": {
"description": "Invalid project object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"403": {
"description": "The user does not have access to the project",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"delete": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Delets a project",
"produces": [
"application/json"
],
"tags": [
"project"
],
"summary": "Deletes a project",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The project was successfully deleted.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"400": {
"description": "Invalid project object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"403": {
"description": "The user does not have access to the project",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/projects/{id}/background": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Get the project background of a specific project. **Returns json on error.**",
"produces": [
"application/octet-stream"
],
"tags": [
"project"
],
"summary": "Get the project background",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The project background file.",
"schema": {
"type": "file"
}
},
"403": {
"description": "No access to this project.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"404": {
"description": "The project does not exist.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"delete": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Removes a previously set project background, regardless of the project provider used to set the background. It does not throw an error if the project does not have a background.",
"produces": [
"application/json"
],
"tags": [
"project"
],
"summary": "Remove a project background",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The project",
"schema": {
"$ref": "#/definitions/models.Project"
}
},
"403": {
"description": "No access to this project.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"404": {
"description": "The project does not exist.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/projects/{id}/backgrounds/unsplash": {
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Sets a photo from unsplash as project background.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"project"
],
"summary": "Set an unsplash photo as project background",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "The image you want to set as background",
"name": "project",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/background.Image"
}
}
],
"responses": {
"200": {
"description": "The background has been successfully set.",
"schema": {
"$ref": "#/definitions/models.Project"
}
},
"400": {
"description": "Invalid image object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"403": {
"description": "The user does not have access to the project",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/projects/{id}/backgrounds/upload": {
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Upload a project background.",
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"tags": [
"project"
],
"summary": "Upload a project background",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The file as single file.",
"name": "background",
"in": "formData",
"required": true
}
],
"responses": {
"200": {
"description": "The background was set successfully.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"400": {
"description": "File is no image.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"403": {
"description": "File too large.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"404": {
"description": "The project does not exist.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/projects/{id}/buckets": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns all kanban buckets with belong to a project including their tasks. Buckets are always sorted by their ` + "`" + `position` + "`" + ` in ascending order. Tasks are sorted by their ` + "`" + `kanban_position` + "`" + ` in ascending order.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
[skip ci] Updated swagger docs
2023-10-24 14:38:04 +00:00
"project"
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
],
"summary": "Get all kanban buckets of a project",
"parameters": [
{
"type": "integer",
"description": "Project Id",
"name": "id",
"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.",
"name": "filter_by",
"in": "query"
},
{
"type": "string",
"description": "The value to filter for.",
"name": "filter_value",
"in": "query"
},
{
"type": "string",
"description": "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` + "`" + `",
"name": "filter_comparator",
"in": "query"
},
{
"type": "string",
"description": "The concatinator to use for filters. Available values are ` + "`" + `and` + "`" + ` or ` + "`" + `or` + "`" + `. Defaults to ` + "`" + `or` + "`" + `.",
"name": "filter_concat",
"in": "query"
},
{
"type": "string",
"description": "If set to true the result will include filtered fields whose value is set to ` + "`" + `null` + "`" + `. Available values are ` + "`" + `true` + "`" + ` or ` + "`" + `false` + "`" + `. Defaults to ` + "`" + `false` + "`" + `.",
"name": "filter_include_nulls",
"in": "query"
}
],
"responses": {
"200": {
"description": "The buckets with their tasks",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.Bucket"
}
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Creates a new kanban bucket on a project.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
[skip ci] Updated swagger docs
2023-10-24 14:38:04 +00:00
"project"
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
],
"summary": "Create a new bucket",
"parameters": [
{
"type": "integer",
"description": "Project Id",
"name": "id",
"in": "path",
"required": true
},
{
"description": "The bucket object",
"name": "bucket",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.Bucket"
}
}
],
"responses": {
"200": {
"description": "The created bucket object.",
"schema": {
"$ref": "#/definitions/models.Bucket"
}
},
"400": {
"description": "Invalid bucket object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "The project does not exist.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/projects/{id}/projectusers": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Lists all users (without emailadresses). Also possible to search for a specific user.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"project"
],
"summary": "Get users",
"parameters": [
{
"type": "string",
"description": "Search for a user by its name.",
"name": "s",
"in": "query"
},
{
"type": "integer",
"description": "Project ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "All (found) users.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/user.User"
}
}
},
"400": {
"description": "Something's invalid.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"401": {
"description": "The user does not have the right to see the project.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal server error.",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/projects/{id}/tasks": {
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns all tasks for the current project.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Get tasks in a project",
"parameters": [
{
"type": "integer",
"description": "The project ID.",
"name": "id",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "The page number. Used for pagination. If not provided, the first page of results is returned.",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "The maximum number of items per page. Note 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 sorting parameter. You can pass this multiple times to get the tasks ordered by multiple different parametes, along with ` + "`" + `order_by` + "`" + `. Possible values to sort by are ` + "`" + `id` + "`" + `, ` + "`" + `title` + "`" + `, ` + "`" + `description` + "`" + `, ` + "`" + `done` + "`" + `, ` + "`" + `done_at` + "`" + `, ` + "`" + `due_date` + "`" + `, ` + "`" + `created_by_id` + "`" + `, ` + "`" + `project_id` + "`" + `, ` + "`" + `repeat_after` + "`" + `, ` + "`" + `priority` + "`" + `, ` + "`" + `start_date` + "`" + `, ` + "`" + `end_date` + "`" + `, ` + "`" + `hex_color` + "`" + `, ` + "`" + `percent_done` + "`" + `, ` + "`" + `uid` + "`" + `, ` + "`" + `created` + "`" + `, ` + "`" + `updated` + "`" + `. Default is ` + "`" + `id` + "`" + `.",
"name": "sort_by",
"in": "query"
},
{
"type": "string",
"description": "The ordering parameter. Possible values to order by are ` + "`" + `asc` + "`" + ` or ` + "`" + `desc` + "`" + `. Default is ` + "`" + `asc` + "`" + `.",
"name": "order_by",
"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.",
"name": "filter_by",
"in": "query"
},
{
"type": "string",
"description": "The value to filter for. You can use [grafana](https://grafana.com/docs/grafana/latest/dashboards/time-range-controls)- or [elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/common-options.html#date-math)-style relative dates for all date fields like ` + "`" + `due_date` + "`" + `, ` + "`" + `start_date` + "`" + `, ` + "`" + `end_date` + "`" + `, etc.",
"name": "filter_value",
"in": "query"
},
{
"type": "string",
"description": "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` + "`" + `",
"name": "filter_comparator",
"in": "query"
},
{
"type": "string",
"description": "The concatinator to use for filters. Available values are ` + "`" + `and` + "`" + ` or ` + "`" + `or` + "`" + `. Defaults to ` + "`" + `or` + "`" + `.",
"name": "filter_concat",
"in": "query"
},
{
"type": "string",
"description": "If set to true the result will include filtered fields whose value is set to ` + "`" + `null` + "`" + `. Available values are ` + "`" + `true` + "`" + ` or ` + "`" + `false` + "`" + `. Defaults to ` + "`" + `false` + "`" + `.",
"name": "filter_include_nulls",
"in": "query"
}
],
"responses": {
"200": {
"description": "The tasks",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.Task"
}
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Inserts a task into a project.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Create a task",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "The task object",
"name": "task",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.Task"
}
}
],
"responses": {
"201": {
"description": "The created task object.",
"schema": {
"$ref": "#/definitions/models.Task"
}
},
"400": {
"description": "Invalid task object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"403": {
"description": "The user does not have access to the project",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/projects/{id}/teams": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns a project with all teams which have access on a given project.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"sharing"
],
"summary": "Get teams on a project",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "The page number. Used for pagination. If not provided, the first page of results is returned.",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.",
"name": "per_page",
"in": "query"
},
{
"type": "string",
"description": "Search teams by its name.",
"name": "s",
"in": "query"
}
],
"responses": {
"200": {
"description": "The teams with their right.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.TeamWithRight"
}
}
},
"403": {
"description": "No right to see the project.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Gives a team access to a project.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"sharing"
],
"summary": "Add a team to a project",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "The team you want to add to the project.",
"name": "project",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.TeamProject"
}
}
],
"responses": {
"201": {
"description": "The created team\u003c-\u003eproject relation.",
"schema": {
"$ref": "#/definitions/models.TeamProject"
}
},
"400": {
"description": "Invalid team project object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"403": {
"description": "The user does not have access to the project",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "The team does not exist.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/projects/{id}/users": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns a project with all users which have access on a given project.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"sharing"
],
"summary": "Get users on a project",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "The page number. Used for pagination. If not provided, the first page of results is returned.",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.",
"name": "per_page",
"in": "query"
},
{
"type": "string",
"description": "Search users by its name.",
"name": "s",
"in": "query"
}
],
"responses": {
"200": {
"description": "The users with the right they have.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.UserWithRight"
}
}
},
"403": {
"description": "No right to see the project.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Gives a user access to a project.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"sharing"
],
"summary": "Add a user to a project",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "The user you want to add to the project.",
"name": "project",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.ProjectUser"
}
}
],
"responses": {
"201": {
"description": "The created user\u003c-\u003eproject relation.",
"schema": {
"$ref": "#/definitions/models.ProjectUser"
}
},
"400": {
"description": "Invalid user project object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"403": {
"description": "The user does not have access to the project",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "The user does not exist.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
docs(webhooks): add swagger docs for all webhook endpoints
2023-10-17 20:29:42 +02:00
"/projects/{id}/webhooks": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Get all api webhook targets for the specified project.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"webhooks"
],
"summary": "Get all api webhook targets for the specified project",
"parameters": [
{
"type": "integer",
"description": "The page number. Used for pagination. If not provided, the first page of results is returned.",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "The maximum number of items per bucket per page. This parameter is limited by the configured maximum of items per page.",
"name": "per_page",
"in": "query"
},
{
"type": "integer",
"description": "Project ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The list of all webhook targets",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.Webhook"
}
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
[skip ci] Updated swagger docs
2023-10-20 11:39:17 +00:00
"description": "Create a webhook target which receives POST requests about specified events from a project.",
docs(webhooks): add swagger docs for all webhook endpoints
2023-10-17 20:29:42 +02:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"webhooks"
],
"summary": "Create a webhook target",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "The webhook target object with required fields",
"name": "webhook",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.Webhook"
}
}
],
"responses": {
"200": {
"description": "The created webhook target.",
"schema": {
"$ref": "#/definitions/models.Webhook"
}
},
"400": {
"description": "Invalid webhook object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/projects/{id}/webhooks/{webhookID}": {
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Change a webhook target's events. You cannot change other values of a webhook.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"webhooks"
],
"summary": "Change a webhook target's events.",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Webhook ID",
"name": "webhookID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Updated webhook target",
"schema": {
"$ref": "#/definitions/models.Webhook"
}
},
"404": {
"description": "The webhok target does not exist",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"delete": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Delete any of the project's webhook targets.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"webhooks"
],
"summary": "Deletes an existing webhook target",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Webhook ID",
"name": "webhookID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Successfully deleted.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"404": {
"description": "The webhok target does not exist.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"/projects/{projectID}/buckets/{bucketID}": {
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Updates an existing kanban bucket.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
[skip ci] Updated swagger docs
2023-10-24 14:38:04 +00:00
"project"
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
],
"summary": "Update an existing bucket",
"parameters": [
{
"type": "integer",
"description": "Project Id",
"name": "projectID",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Bucket Id",
"name": "bucketID",
"in": "path",
"required": true
},
{
"description": "The bucket object",
"name": "bucket",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.Bucket"
}
}
],
"responses": {
"200": {
"description": "The created bucket object.",
"schema": {
"$ref": "#/definitions/models.Bucket"
}
},
"400": {
"description": "Invalid bucket object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "The bucket does not exist.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"delete": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Deletes an existing kanban bucket and dissociates all of its task. It does not delete any tasks. You cannot delete the last bucket on a project.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
[skip ci] Updated swagger docs
2023-10-24 14:38:04 +00:00
"project"
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
],
"summary": "Deletes an existing bucket",
"parameters": [
{
"type": "integer",
"description": "Project Id",
"name": "projectID",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Bucket Id",
"name": "bucketID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Successfully deleted.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"404": {
"description": "The bucket does not exist.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/projects/{projectID}/duplicate": {
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Copies the project, tasks, files, kanban data, assignees, comments, attachments, lables, relations, backgrounds, user/team rights and link shares from one project to a new one. The user needs read access in the project and write access in the parent of the new project.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"project"
],
"summary": "Duplicate an existing project",
"parameters": [
{
"type": "integer",
"description": "The project ID to duplicate",
"name": "projectID",
"in": "path",
"required": true
},
{
"description": "The target parent project which should hold the copied project.",
"name": "project",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.ProjectDuplicate"
}
}
],
"responses": {
"201": {
"description": "The created project.",
"schema": {
"$ref": "#/definitions/models.ProjectDuplicate"
}
},
"400": {
"description": "Invalid project duplicate object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"403": {
"description": "The user does not have access to the project or its parent.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/projects/{projectID}/teams/{teamID}": {
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Update a team \u003c-\u003e project relation. Mostly used to update the right that team has.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"sharing"
],
"summary": "Update a team \u003c-\u003e project relation",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "projectID",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Team ID",
"name": "teamID",
"in": "path",
"required": true
},
{
"description": "The team you want to update.",
"name": "project",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.TeamProject"
}
}
],
"responses": {
"200": {
"description": "The updated team \u003c-\u003e project relation.",
"schema": {
"$ref": "#/definitions/models.TeamProject"
}
},
"403": {
"description": "The user does not have admin-access to the project",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "Team or project does not exist.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"delete": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Delets a team from a project. The team won't have access to the project anymore.",
"produces": [
"application/json"
],
"tags": [
"sharing"
],
"summary": "Delete a team from a project",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "projectID",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Team ID",
"name": "teamID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The team was successfully deleted.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"403": {
"description": "The user does not have access to the project",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "Team or project does not exist.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/projects/{projectID}/users/{userID}": {
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Update a user \u003c-\u003e project relation. Mostly used to update the right that user has.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"sharing"
],
"summary": "Update a user \u003c-\u003e project relation",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "projectID",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "User ID",
"name": "userID",
"in": "path",
"required": true
},
{
"description": "The user you want to update.",
"name": "project",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.ProjectUser"
}
}
],
"responses": {
"200": {
"description": "The updated user \u003c-\u003e project relation.",
"schema": {
"$ref": "#/definitions/models.ProjectUser"
}
},
"403": {
"description": "The user does not have admin-access to the project",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "User or project does not exist.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"delete": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Delets a user from a project. The user won't have access to the project anymore.",
"produces": [
"application/json"
],
"tags": [
"sharing"
],
"summary": "Delete a user from a project",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "projectID",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "User ID",
"name": "userID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The user was successfully removed from the project.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"403": {
"description": "The user does not have access to the project",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "user or project does not exist.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/projects/{project}/shares": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns all link shares which exist for a given project",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"sharing"
],
"summary": "Get all link shares for a project",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "project",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "The page number. Used for pagination. If not provided, the first page of results is returned.",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.",
"name": "per_page",
"in": "query"
},
{
"type": "string",
"description": "Search shares by hash.",
"name": "s",
"in": "query"
}
],
"responses": {
"200": {
"description": "The share links",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.LinkSharing"
}
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Share a project via link. The user needs to have write-access to the project to be able do this.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"sharing"
],
"summary": "Share a project via link",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "project",
"in": "path",
"required": true
},
{
"description": "The new link share object",
"name": "label",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.LinkSharing"
}
}
],
"responses": {
"201": {
"description": "The created link share object.",
"schema": {
"$ref": "#/definitions/models.LinkSharing"
}
},
"400": {
"description": "Invalid link share object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"403": {
"description": "Not allowed to add the project share.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "The project does not exist.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/projects/{project}/shares/{share}": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns one link share by its ID.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"sharing"
],
"summary": "Get one link shares for a project",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "project",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Share ID",
"name": "share",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The share links",
"schema": {
"$ref": "#/definitions/models.LinkSharing"
}
},
"403": {
"description": "No access to the project",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "Share Link not found.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"delete": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Remove a link share. The user needs to have write-access to the project to be able do this.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"sharing"
],
"summary": "Remove a link share",
"parameters": [
{
"type": "integer",
"description": "Project ID",
"name": "project",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Share Link ID",
"name": "share",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The link was successfully removed.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"403": {
"description": "Not allowed to remove the link.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "Share Link not found.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/register": {
"post": {
"description": "Creates a new user account.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"auth"
],
"summary": "Register",
"parameters": [
{
"description": "The user credentials",
"name": "credentials",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/user.APIUserPassword"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/user.User"
}
},
"400": {
"description": "No or invalid user register object provided / User already exists.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/routes": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns a list of all API routes which are available to use with an api token, not a user login.",
"produces": [
"application/json"
],
"tags": [
"api"
],
"summary": "Get a list of all token api routes",
"responses": {
"200": {
"description": "The list of all routes.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.APITokenRoute"
}
}
}
}
}
},
"/shares/{share}/auth": {
"post": {
"description": "Get a jwt auth token for a shared project from a share hash.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"sharing"
],
"summary": "Get an auth token for a share",
"parameters": [
{
"description": "The password for link shares which require one.",
"name": "password",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.LinkShareAuth"
}
},
{
"type": "string",
"description": "The share hash",
"name": "share",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The valid jwt auth token.",
"schema": {
"$ref": "#/definitions/auth.Token"
}
},
"400": {
"description": "Invalid link share object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/subscriptions/{entity}/{entityID}": {
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Subscribes the current user to an entity.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"subscriptions"
],
"summary": "Subscribes the current user to an entity.",
"parameters": [
{
"type": "string",
"description": "The entity the user subscribes to. Can be either ` + "`" + `project` + "`" + ` or ` + "`" + `task` + "`" + `.",
"name": "entity",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The numeric id of the entity to subscribe to.",
"name": "entityID",
"in": "path",
"required": true
}
],
"responses": {
"201": {
"description": "The subscription",
"schema": {
"$ref": "#/definitions/models.Subscription"
}
},
"403": {
"description": "The user does not have access to subscribe to this entity.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"412": {
"description": "The subscription entity is invalid.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"delete": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Unsubscribes the current user to an entity.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"subscriptions"
],
"summary": "Unsubscribe the current user from an entity.",
"parameters": [
{
"type": "string",
"description": "The entity the user subscribed to. Can be either ` + "`" + `project` + "`" + ` or ` + "`" + `task` + "`" + `.",
"name": "entity",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The numeric id of the subscribed entity to.",
"name": "entityID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The subscription",
"schema": {
"$ref": "#/definitions/models.Subscription"
}
},
"403": {
"description": "The user does not have access to subscribe to this entity.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "The subscription does not exist.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/tasks/all": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns all tasks on any project the user has access to.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Get tasks",
"parameters": [
{
"type": "integer",
"description": "The page number. Used for pagination. If not provided, the first page of results is returned.",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "The maximum number of items per page. Note 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 sorting parameter. You can pass this multiple times to get the tasks ordered by multiple different parameters, along with ` + "`" + `order_by` + "`" + `. Possible values to sort by are ` + "`" + `id` + "`" + `, ` + "`" + `title` + "`" + `, ` + "`" + `description` + "`" + `, ` + "`" + `done` + "`" + `, ` + "`" + `done_at` + "`" + `, ` + "`" + `due_date` + "`" + `, ` + "`" + `created_by_id` + "`" + `, ` + "`" + `project_id` + "`" + `, ` + "`" + `repeat_after` + "`" + `, ` + "`" + `priority` + "`" + `, ` + "`" + `start_date` + "`" + `, ` + "`" + `end_date` + "`" + `, ` + "`" + `hex_color` + "`" + `, ` + "`" + `percent_done` + "`" + `, ` + "`" + `uid` + "`" + `, ` + "`" + `created` + "`" + `, ` + "`" + `updated` + "`" + `. Default is ` + "`" + `id` + "`" + `.",
"name": "sort_by",
"in": "query"
},
{
"type": "string",
"description": "The ordering parameter. Possible values to order by are ` + "`" + `asc` + "`" + ` or ` + "`" + `desc` + "`" + `. Default is ` + "`" + `asc` + "`" + `.",
"name": "order_by",
"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.",
"name": "filter_by",
"in": "query"
},
{
"type": "string",
"description": "The value to filter for.",
"name": "filter_value",
"in": "query"
},
{
"type": "string",
"description": "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` + "`" + `",
"name": "filter_comparator",
"in": "query"
},
{
"type": "string",
"description": "The concatinator to use for filters. Available values are ` + "`" + `and` + "`" + ` or ` + "`" + `or` + "`" + `. Defaults to ` + "`" + `or` + "`" + `.",
"name": "filter_concat",
"in": "query"
},
{
"type": "string",
"description": "If set to true the result will include filtered fields whose value is set to ` + "`" + `null` + "`" + `. Available values are ` + "`" + `true` + "`" + ` or ` + "`" + `false` + "`" + `. Defaults to ` + "`" + `false` + "`" + `.",
"name": "filter_include_nulls",
"in": "query"
}
],
"responses": {
"200": {
"description": "The tasks",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.Task"
}
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/tasks/bulk": {
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Updates a bunch of tasks at once. This includes marking them as done. Note: although you could supply another ID, it will be ignored. Use task_ids instead.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Update a bunch of tasks at once",
"parameters": [
{
"description": "The task object. Looks like a normal task, the only difference is it uses an array of project_ids to update.",
"name": "task",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.BulkTask"
}
}
],
"responses": {
"200": {
"description": "The updated task object.",
"schema": {
"$ref": "#/definitions/models.Task"
}
},
"400": {
"description": "Invalid task object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"403": {
"description": "The user does not have access to the task (aka its project)",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"/tasks/{id}": {
"get": {
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"security": [
{
"JWTKeyAuth": []
}
],
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"description": "Returns one task by its ID",
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"task"
],
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"summary": "Get one task",
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"parameters": [
{
"type": "integer",
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"description": "The task ID",
"name": "id",
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"in": "path",
"required": true
}
],
"responses": {
"200": {
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"description": "The task",
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"schema": {
"$ref": "#/definitions/models.Task"
}
},
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"404": {
"description": "Task not found",
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"schema": {
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"$ref": "#/definitions/models.Message"
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"post": {
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"security": [
{
"JWTKeyAuth": []
}
],
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"description": "Updates a task. This includes marking it as done. Assignees you pass will be updated, see their individual endpoints for more details on how this is done. To update labels, see the description of the endpoint.",
"consumes": [
"application/json"
],
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"produces": [
"application/json"
],
"tags": [
"task"
],
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"summary": "Update a task",
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"parameters": [
{
"type": "integer",
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"description": "The Task ID",
"name": "id",
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"in": "path",
"required": true
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
},
{
"description": "The task object",
"name": "task",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.Task"
}
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
}
],
"responses": {
"200": {
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"description": "The updated task object.",
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"schema": {
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"$ref": "#/definitions/models.Task"
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
}
},
"400": {
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"description": "Invalid task object provided.",
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"403": {
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"description": "The user does not have access to the task (aka its project)",
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
},
"delete": {
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"security": [
{
"JWTKeyAuth": []
}
],
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"description": "Deletes a task from a project. This does not mean \"mark it done\".",
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"produces": [
"application/json"
],
"tags": [
"task"
],
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"summary": "Delete a task",
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"parameters": [
{
"type": "integer",
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"description": "Task ID",
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"description": "The created task object.",
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"schema": {
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"$ref": "#/definitions/models.Message"
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
}
},
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"400": {
"description": "Invalid task ID provided.",
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"schema": {
[skip ci] Updated swagger docs
2023-11-16 12:20:35 +00:00
"$ref": "#/definitions/web.HTTPError"
}
},
"403": {
"description": "The user does not have access to the project",
"schema": {
"$ref": "#/definitions/web.HTTPError"
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/tasks/{id}/attachments": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Get all task attachments for one task.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Get all attachments for one task.",
"parameters": [
{
"type": "integer",
"description": "Task ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "The page number. Used for pagination. If not provided, the first page of results is returned.",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.",
"name": "per_page",
"in": "query"
}
],
"responses": {
"200": {
"description": "All attachments for this task",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.TaskAttachment"
}
}
},
"403": {
"description": "No access to this task.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"404": {
"description": "The task does not exist.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Upload a task attachment. You can pass multiple files with the files form param.",
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Upload a task attachment",
"parameters": [
{
"type": "integer",
"description": "Task ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The file, as multipart form file. You can pass multiple.",
"name": "files",
"in": "formData",
"required": true
}
],
"responses": {
"200": {
"description": "Attachments were uploaded successfully.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"403": {
"description": "No access to the task.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"404": {
"description": "The task does not exist.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/tasks/{id}/attachments/{attachmentID}": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Get one attachment for download. **Returns json on error.**",
"produces": [
"application/octet-stream"
],
"tags": [
"task"
],
"summary": "Get one attachment.",
"parameters": [
{
"type": "integer",
"description": "Task ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Attachment ID",
"name": "attachmentID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The attachment file.",
"schema": {
"type": "file"
}
},
"403": {
"description": "No access to this task.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"404": {
"description": "The task does not exist.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"delete": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Delete an attachment.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Delete an attachment",
"parameters": [
{
"type": "integer",
"description": "Task ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Attachment ID",
"name": "attachmentID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The attachment was deleted successfully.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"403": {
"description": "No access to this task.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"404": {
"description": "The task does not exist.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/tasks/{taskID}/assignees": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns an array with all assignees for this task.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"assignees"
],
"summary": "Get all assignees for a task",
"parameters": [
{
"type": "integer",
"description": "The page number. Used for pagination. If not provided, the first page of results is returned.",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.",
"name": "per_page",
"in": "query"
},
{
"type": "string",
"description": "Search assignees by their username.",
"name": "s",
"in": "query"
},
{
"type": "integer",
"description": "Task ID",
"name": "taskID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The assignees",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/user.User"
}
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Adds a new assignee to a task. The assignee needs to have access to the project, the doer must be able to edit this task.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"assignees"
],
"summary": "Add a new assignee to a task",
"parameters": [
{
"description": "The assingee object",
"name": "assignee",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.TaskAssginee"
}
},
{
"type": "integer",
"description": "Task ID",
"name": "taskID",
"in": "path",
"required": true
}
],
"responses": {
"201": {
"description": "The created assingee object.",
"schema": {
"$ref": "#/definitions/models.TaskAssginee"
}
},
"400": {
"description": "Invalid assignee object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/tasks/{taskID}/assignees/bulk": {
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Adds multiple new assignees to a task. The assignee needs to have access to the project, the doer must be able to edit this task. Every user not in the project will be unassigned from the task, pass an empty array to unassign everyone.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"assignees"
],
"summary": "Add multiple new assignees to a task",
"parameters": [
{
"description": "The array of assignees",
"name": "assignee",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.BulkAssignees"
}
},
{
"type": "integer",
"description": "Task ID",
"name": "taskID",
"in": "path",
"required": true
}
],
"responses": {
"201": {
"description": "The created assingees object.",
"schema": {
"$ref": "#/definitions/models.TaskAssginee"
}
},
"400": {
"description": "Invalid assignee object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/tasks/{taskID}/assignees/{userID}": {
"delete": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Un-assign a user from a task.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"assignees"
],
"summary": "Delete an assignee",
"parameters": [
{
"type": "integer",
"description": "Task ID",
"name": "taskID",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Assignee user ID",
"name": "userID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The assignee was successfully deleted.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"403": {
"description": "Not allowed to delete the assignee.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/tasks/{taskID}/comments": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Get all task comments. The user doing this need to have at least read access to the task.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Get all task comments",
"parameters": [
{
"type": "integer",
"description": "Task ID",
"name": "taskID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The array with all task comments",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.TaskComment"
}
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Create a new task comment. The user doing this need to have at least write access to the task this comment should belong to.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Create a new task comment",
"parameters": [
{
"description": "The task comment object",
"name": "relation",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.TaskComment"
}
},
{
"type": "integer",
"description": "Task ID",
"name": "taskID",
"in": "path",
"required": true
}
],
"responses": {
"201": {
"description": "The created task comment object.",
"schema": {
"$ref": "#/definitions/models.TaskComment"
}
},
"400": {
"description": "Invalid task comment object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/tasks/{taskID}/comments/{commentID}": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Remove a task comment. The user doing this need to have at least read access to the task this comment belongs to.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Remove a task comment",
"parameters": [
{
"type": "integer",
"description": "Task ID",
"name": "taskID",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Comment ID",
"name": "commentID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The task comment object.",
"schema": {
"$ref": "#/definitions/models.TaskComment"
}
},
"400": {
"description": "Invalid task comment object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "The task comment was not found.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Update an existing task comment. The user doing this need to have at least write access to the task this comment belongs to.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Update an existing task comment",
"parameters": [
{
"type": "integer",
"description": "Task ID",
"name": "taskID",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Comment ID",
"name": "commentID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The updated task comment object.",
"schema": {
"$ref": "#/definitions/models.TaskComment"
}
},
"400": {
"description": "Invalid task comment object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "The task comment was not found.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"delete": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Remove a task comment. The user doing this need to have at least write access to the task this comment belongs to.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Remove a task comment",
"parameters": [
{
"type": "integer",
"description": "Task ID",
"name": "taskID",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Comment ID",
"name": "commentID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The task comment was successfully deleted.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"400": {
"description": "Invalid task comment object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "The task comment was not found.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/tasks/{taskID}/labels/bulk": {
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Updates all labels on a task. Every label which is not passed but exists on the task will be deleted. Every label which does not exist on the task will be added. All labels which are passed and already exist on the task won't be touched.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"labels"
],
"summary": "Update all labels on a task.",
"parameters": [
{
"description": "The array of labels",
"name": "label",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.LabelTaskBulk"
}
},
{
"type": "integer",
"description": "Task ID",
"name": "taskID",
"in": "path",
"required": true
}
],
"responses": {
"201": {
"description": "The updated labels object.",
"schema": {
"$ref": "#/definitions/models.LabelTaskBulk"
}
},
"400": {
"description": "Invalid label object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/tasks/{taskID}/relations": {
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Creates a new relation between two tasks. The user needs to have update rights on the base task and at least read rights on the other task. Both tasks do not need to be on the same project. Take a look at the docs for available task relation kinds.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Create a new relation between two tasks",
"parameters": [
{
"description": "The relation object",
"name": "relation",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.TaskRelation"
}
},
{
"type": "integer",
"description": "Task ID",
"name": "taskID",
"in": "path",
"required": true
}
],
"responses": {
"201": {
"description": "The created task relation object.",
"schema": {
"$ref": "#/definitions/models.TaskRelation"
}
},
"400": {
"description": "Invalid task relation object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/tasks/{taskID}/relations/{relationKind}/{otherTaskID}": {
"delete": {
"security": [
{
"JWTKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Remove a task relation",
"parameters": [
{
"description": "The relation object",
"name": "relation",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.TaskRelation"
}
},
{
"type": "integer",
"description": "Task ID",
"name": "taskID",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The kind of the relation. See the TaskRelation type for more info.",
"name": "relationKind",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "The id of the other task.",
"name": "otherTaskID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The task relation was successfully deleted.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"400": {
"description": "Invalid task relation object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "The task relation was not found.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/tasks/{task}/labels": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns all labels which are assicociated with a given task.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"labels"
],
"summary": "Get all labels on a task",
"parameters": [
{
"type": "integer",
"description": "Task ID",
"name": "task",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "The page number. Used for pagination. If not provided, the first page of results is returned.",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.",
"name": "per_page",
"in": "query"
},
{
"type": "string",
"description": "Search labels by label text.",
"name": "s",
"in": "query"
}
],
"responses": {
"200": {
"description": "The labels",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.Label"
}
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Add a label to a task. The user needs to have write-access to the project to be able do this.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"labels"
],
"summary": "Add a label to a task",
"parameters": [
{
"type": "integer",
"description": "Task ID",
"name": "task",
"in": "path",
"required": true
},
{
"description": "The label object",
"name": "label",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.LabelTask"
}
}
],
"responses": {
"201": {
"description": "The created label relation object.",
"schema": {
"$ref": "#/definitions/models.LabelTask"
}
},
"400": {
"description": "Invalid label object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"403": {
"description": "Not allowed to add the label.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "The label does not exist.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/tasks/{task}/labels/{label}": {
"delete": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Remove a label from a task. The user needs to have write-access to the project to be able do this.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"labels"
],
"summary": "Remove a label from a task",
"parameters": [
{
"type": "integer",
"description": "Task ID",
"name": "task",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Label ID",
"name": "label",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The label was successfully removed.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"403": {
"description": "Not allowed to remove the label.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"404": {
"description": "Label not found.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/teams": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns all teams the current user is part of.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"team"
],
"summary": "Get teams",
"parameters": [
{
"type": "integer",
"description": "The page number. Used for pagination. If not provided, the first page of results is returned.",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.",
"name": "per_page",
"in": "query"
},
{
"type": "string",
"description": "Search teams by its name.",
"name": "s",
"in": "query"
}
],
"responses": {
"200": {
"description": "The teams.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.Team"
}
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Creates a new team.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"team"
],
"summary": "Creates a new team",
"parameters": [
{
"description": "The team you want to create.",
"name": "team",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.Team"
}
}
],
"responses": {
"201": {
"description": "The created team.",
"schema": {
"$ref": "#/definitions/models.Team"
}
},
"400": {
"description": "Invalid team object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/teams/{id}": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns a team by its ID.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"team"
],
"summary": "Gets one team",
"parameters": [
{
"type": "integer",
"description": "Team ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The team",
"schema": {
"$ref": "#/definitions/models.Team"
}
},
"403": {
"description": "The user does not have access to the team",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Updates a team.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"team"
],
"summary": "Updates a team",
"parameters": [
{
"type": "integer",
"description": "Team ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "The team with updated values you want to update.",
"name": "team",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.Team"
}
}
],
"responses": {
"200": {
"description": "The updated team.",
"schema": {
"$ref": "#/definitions/models.Team"
}
},
"400": {
"description": "Invalid team object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"delete": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Delets a team. This will also remove the access for all users in that team.",
"produces": [
"application/json"
],
"tags": [
"team"
],
"summary": "Deletes a team",
"parameters": [
{
"type": "integer",
"description": "Team ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The team was successfully deleted.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"400": {
"description": "Invalid team object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/teams/{id}/members": {
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Add a user to a team.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"team"
],
"summary": "Add a user to a team",
"parameters": [
{
"type": "integer",
"description": "Team ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "The user to be added to a team.",
"name": "team",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.TeamMember"
}
}
],
"responses": {
"201": {
"description": "The newly created member object",
"schema": {
"$ref": "#/definitions/models.TeamMember"
}
},
"400": {
"description": "Invalid member object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"403": {
"description": "The user does not have access to the team",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/teams/{id}/members/{userID}": {
"delete": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Remove a user from a team. This will also revoke any access this user might have via that team. A user can remove themselves from the team if they are not the last user in the team.",
"produces": [
"application/json"
],
"tags": [
"team"
],
"summary": "Remove a user from a team",
"parameters": [
{
"type": "integer",
"description": "Team ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "User ID",
"name": "userID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The user was successfully removed from the team.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/teams/{id}/members/{userID}/admin": {
"post": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "If a user is team admin, this will make them member and vise-versa.",
"produces": [
"application/json"
],
"tags": [
"team"
],
"summary": "Toggle a team member's admin status",
"parameters": [
{
"type": "integer",
"description": "Team ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "User ID",
"name": "userID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "The member right was successfully changed.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/test/{table}": {
"patch": {
"description": "Fills the specified table with the content provided in the payload. You need to enable the testing endpoint before doing this and provide the ` + "`" + `Authorization: \u003ctoken\u003e` + "`" + ` secret when making requests to this endpoint. See docs for more details.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"testing"
],
"summary": "Reset the db to a defined state",
"parameters": [
{
"type": "string",
"description": "The table to reset",
"name": "table",
"in": "path",
"required": true
}
],
"responses": {
"201": {
"description": "Everything has been imported successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/user.User"
}
}
},
"500": {
"description": "Internal server error.",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/tokens": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns all api tokens the current user has created.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"api"
],
"summary": "Get all api tokens of the current user",
"parameters": [
{
"type": "integer",
docs(webhooks): add swagger docs for all webhook endpoints
2023-10-17 20:29:42 +02:00
"description": "The page number, used for pagination. If not provided, the first page of results is returned.",
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"name": "page",
"in": "query"
},
{
"type": "integer",
docs(webhooks): add swagger docs for all webhook endpoints
2023-10-17 20:29:42 +02:00
"description": "The maximum number of tokens per page. This parameter is limited by the configured maximum of items per page.",
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"name": "per_page",
"in": "query"
},
{
"type": "string",
docs(webhooks): add swagger docs for all webhook endpoints
2023-10-17 20:29:42 +02:00
"description": "Search tokens by their title.",
fix(swagger): add generated swagger docs to repo
2023-09-06 18:01:45 +02:00
"name": "s",
"in": "query"
}
],
"responses": {
"200": {
"description": "The list of all tokens",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.APIToken"
}
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
},
"put": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Create a new api token to use on behalf of the user creating it.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"api"
],
"summary": "Create a new api token",
"parameters": [
{
"description": "The token object with required fields",
"name": "token",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.APIToken"
}
}
],
"responses": {
"200": {
"description": "The created token.",
"schema": {
"$ref": "#/definitions/models.APIToken"
}
},
"400": {
"description": "Invalid token object provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/tokens/{tokenID}": {
"delete": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Delete any of the user's api tokens.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"api"
],
"summary": "Deletes an existing api token",
"parameters": [
{
"type": "integer",
"description": "Token ID",
"name": "tokenID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Successfully deleted.",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"404": {
"description": "The token does not exist.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/user": {
"get": {
"security": [
{
"JWTKeyAuth": []
}
],
"description": "Returns the current user object.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Get user information",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/user.User"
}
},
"404": {
"description": "User does not exist.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal server error.",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/user/confirm": {
"post": {
"description": "Confirms the email of a newly registered user.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Confirm the email of a new user",
"parameters": [
{
"description": "The token.",
"name": "credentials",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/user.EmailConfirm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"412": {
"description": "Bad token provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/user/deletion/cancel": {
"post": {
"description": "Aborts an in-progress user deletion.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Abort a user deletion request",
"parameters": [
{
"description": "The user password to confirm.",
"name": "credentials",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.UserPasswordConfirmation"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.Message"
}
},
"412": {
"description": "Bad password provided.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/user/deletion/confirm": {