clone/vikunja
1
0
Fork 0
mirror of https://github.com/go-vikunja/vikunja.git synced 2026-02-01 22:47:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

[skip ci] Updated swagger docs

Browse Source
This commit is contained in:
Frederick [Bot]
2025-08-13 09:23:47 +00:00
parent 89bddff626
commit 6a91862384
3 changed files with 134 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
pkg/swagger/docs.go
View File

@@ -1417,7 +1417,7 @@ const docTemplate = `{
},
{
"type": "string",
"description": "If set to ` + "`" + `rights` + "`" + `, Vikunja will return the max right the current user has on this project. You can currently only set this to ` + "`" + `rights` + "`" + `.",
"description": "If set to ` + "`" + `permissions` + "`" + `, Vikunja will return the max permission the current user has on this project. You can currently only set this to ` + "`" + `permissions` + "`" + `.",
"name": "expand",
"in": "query"
}
@@ -1947,7 +1947,7 @@ const docTemplate = `{
}
},
"401": {
"description": "The user does not have the right to see the project.",
"description": "The user does not have the permission to see the project.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
@@ -2072,16 +2072,16 @@ const docTemplate = `{
],
"responses": {
"200": {
"description": "The teams with their right.",
"description": "The teams with their permission.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.TeamWithRight"
"$ref": "#/definitions/models.TeamWithPermission"
}
}
},
"403": {
"description": "No right to see the project.",
"description": "No permission to see the project.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
@@ -2210,16 +2210,16 @@ const docTemplate = `{
],
"responses": {
"200": {
"description": "The users with the right they have.",
"description": "The users with the permission they have.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.UserWithRight"
"$ref": "#/definitions/models.UserWithPermission"
}
}
},
"403": {
"description": "No right to see the project.",
"description": "No permission to see the project.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
@@ -2761,7 +2761,7 @@ const docTemplate = `{
"JWTKeyAuth": []
}
],
"description": "Copies the project, tasks, files, kanban data, assignees, comments, attachments, labels, 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.",
"description": "Copies the project, tasks, files, kanban data, assignees, comments, attachments, labels, relations, backgrounds, user/team permissions 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"
],
@@ -2825,7 +2825,7 @@ const docTemplate = `{
"JWTKeyAuth": []
}
],
"description": "Update a team \u003c-\u003e project relation. Mostly used to update the right that team has.",
"description": "Update a team \u003c-\u003e project relation. Mostly used to update the permission that team has.",
"consumes": [
"application/json"
],
@@ -2953,7 +2953,7 @@ const docTemplate = `{
"JWTKeyAuth": []
}
],
"description": "Update a user \u003c-\u003e project relation. Mostly used to update the right that user has.",
"description": "Update a user \u003c-\u003e project relation. Mostly used to update the permission that user has.",
"consumes": [
"application/json"
],
@@ -5284,7 +5284,7 @@ const docTemplate = `{
"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.",
"description": "Creates a new relation between two tasks. The user needs to have update permissions on the base task and at least read permissions 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"
],
@@ -5958,7 +5958,7 @@ const docTemplate = `{
],
"responses": {
"200": {
"description": "The member right was successfully changed.",
"description": "The member permission was successfully changed.",
"schema": {
"$ref": "#/definitions/models.Message"
}
@@ -8264,8 +8264,8 @@ const docTemplate = `{
"description": "The password of this link share. You can only set it, not retrieve it after the link share has been created.",
"type": "string"
},
"right": {
"description": "The right this project is shared with. 0 = Read only, 1 = Read \u0026 Write, 2 = Admin. See the docs for more details.",
"permission": {
"description": "The permission this project is shared with. 0 = Read only, 1 = Read \u0026 Write, 2 = Admin. See the docs for more details.",
"default": 0,
"maximum": 2,
"allOf": [
@@ -8307,6 +8307,19 @@ const docTemplate = `{
}
}
},
"models.Permission": {
"type": "integer",
"enum": [
0,
1,
2
],
"x-enum-varnames": [
"PermissionRead",
"PermissionWrite",
"PermissionAdmin"
]
},
"models.Project": {
"type": "object",
"properties": {
@@ -8348,7 +8361,7 @@ const docTemplate = `{
"description": "True if a project is a favorite. Favorite projects show up in a separate parent project. This value depends on the user making the call to the api.",
"type": "boolean"
},
"max_right": {
"max_permission": {
"$ref": "#/definitions/models.Permission"
},
"owner": {
@@ -8420,8 +8433,8 @@ const docTemplate = `{
"description": "The unique, numeric id of this project \u003c-\u003e user relation.",
"type": "integer"
},
"right": {
"description": "The right this user has. 0 = Read only, 1 = Read \u0026 Write, 2 = Admin. See the docs for more details.",
"permission": {
"description": "The permission this user has. 0 = Read only, 1 = Read \u0026 Write, 2 = Admin. See the docs for more details.",
"default": 0,
"maximum": 2,
"allOf": [
@@ -8606,19 +8619,6 @@ const docTemplate = `{
"ReminderRelationEndDate"
]
},
"models.Permission": {
"type": "integer",
"enum": [
0,
1,
2
],
"x-enum-varnames": [
"RightRead",
"RightWrite",
"RightAdmin"
]
},
"models.RouteDetail": {
"type": "object",
"properties": {
@@ -9160,8 +9160,8 @@ const docTemplate = `{
"description": "The unique, numeric id of this project \u003c-\u003e team relation.",
"type": "integer"
},
"right": {
"description": "The right this team has. 0 = Read only, 1 = Read \u0026 Write, 2 = Admin. See the docs for more details.",
"permission": {
"description": "The permission this team has. 0 = Read only, 1 = Read \u0026 Write, 2 = Admin. See the docs for more details.",
"default": 0,
"maximum": 2,
"allOf": [
@@ -9216,7 +9216,7 @@ const docTemplate = `{
}
}
},
"models.TeamWithRight": {
"models.TeamWithPermission": {
"type": "object",
"properties": {
"created": {
@@ -9265,7 +9265,7 @@ const docTemplate = `{
"maxLength": 250,
"minLength": 1
},
"right": {
"permission": {
"$ref": "#/definitions/models.Permission"
},
"updated": {
@@ -9274,7 +9274,7 @@ const docTemplate = `{
}
}
},
"models.UserWithRight": {
"models.UserWithPermission": {
"type": "object",
"properties": {
"created": {
@@ -9294,7 +9294,7 @@ const docTemplate = `{
"description": "The full name of the user.",
"type": "string"
},
"right": {
"permission": {
"$ref": "#/definitions/models.Permission"
},
"updated": {
@@ -9880,7 +9880,7 @@ var SwaggerInfo = &swag.Spec{
BasePath: "/api/v1",
Schemes: []string{},
Title: "Vikunja API",
Description: "# Pagination\nEvery endpoint capable of pagination will return two headers:\n* `x-pagination-total-pages`: The total number of available pages for this request\n* `x-pagination-result-count`: The number of items returned for this request.\n# Rights\nAll endpoints which return a single item (project, task, etc.) - no array - will also return a `x-max-right` header with the max right the user has on this item as an int where `0` is `Read Only`, `1` is `Read & Write` and `2` is `Admin`.\nThis can be used to show or hide ui elements based on the rights the user has.\n# Errors\nAll errors have an error code and a human-readable error message in addition to the http status code. You should always check for the status code in the response, not only the http status code.\nDue to limitations in the swagger library we're using for this document, only one error per http status code is documented here. Make sure to check the [error docs](https://vikunja.io/docs/errors/) in Vikunja's documentation for a full list of available error codes.\n# Authorization\n**JWT-Auth:** Main authorization method, used for most of the requests. Needs `Authorization: Bearer <jwt-token>`-header to authenticate successfully.\n\n**API Token:** You can create scoped API tokens for your user and use the token to make authenticated requests in the context of that user. The token must be provided via an `Authorization: Bearer <token>` header, similar to jwt auth. See the documentation for the `api` group to manage token creation and revocation.\n\n**BasicAuth:** Only used when requesting tasks via CalDAV.\n<!-- ReDoc-Inject: <security-definitions> -->",
Description: "# Pagination\nEvery endpoint capable of pagination will return two headers:\n* `x-pagination-total-pages`: The total number of available pages for this request\n* `x-pagination-result-count`: The number of items returned for this request.\n# Permissions\nAll endpoints which return a single item (project, task, etc.) - no array - will also return a `x-max-permission` header with the max permission the user has on this item as an int where `0` is `Read Only`, `1` is `Read & Write` and `2` is `Admin`.\nThis can be used to show or hide ui elements based on the permissions the user has.\n# Errors\nAll errors have an error code and a human-readable error message in addition to the http status code. You should always check for the status code in the response, not only the http status code.\nDue to limitations in the swagger library we're using for this document, only one error per http status code is documented here. Make sure to check the [error docs](https://vikunja.io/docs/errors/) in Vikunja's documentation for a full list of available error codes.\n# Authorization\n**JWT-Auth:** Main authorization method, used for most of the requests. Needs `Authorization: Bearer <jwt-token>`-header to authenticate successfully.\n\n**API Token:** You can create scoped API tokens for your user and use the token to make authenticated requests in the context of that user. The token must be provided via an `Authorization: Bearer <token>` header, similar to jwt auth. See the documentation for the `api` group to manage token creation and revocation.\n\n**BasicAuth:** Only used when requesting tasks via CalDAV.\n<!-- ReDoc-Inject: <security-definitions> -->",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
LeftDelim: "{{",

88
pkg/swagger/swagger.json
View File

@@ -1,7 +1,7 @@
{
"swagger": "2.0",
"info": {
"description": "# Pagination\nEvery endpoint capable of pagination will return two headers:\n* `x-pagination-total-pages`: The total number of available pages for this request\n* `x-pagination-result-count`: The number of items returned for this request.\n# Rights\nAll endpoints which return a single item (project, task, etc.) - no array - will also return a `x-max-right` header with the max right the user has on this item as an int where `0` is `Read Only`, `1` is `Read \u0026 Write` and `2` is `Admin`.\nThis can be used to show or hide ui elements based on the rights the user has.\n# Errors\nAll errors have an error code and a human-readable error message in addition to the http status code. You should always check for the status code in the response, not only the http status code.\nDue to limitations in the swagger library we're using for this document, only one error per http status code is documented here. Make sure to check the [error docs](https://vikunja.io/docs/errors/) in Vikunja's documentation for a full list of available error codes.\n# Authorization\n**JWT-Auth:** Main authorization method, used for most of the requests. Needs `Authorization: Bearer \u003cjwt-token\u003e`-header to authenticate successfully.\n\n**API Token:** You can create scoped API tokens for your user and use the token to make authenticated requests in the context of that user. The token must be provided via an `Authorization: Bearer \u003ctoken\u003e` header, similar to jwt auth. See the documentation for the `api` group to manage token creation and revocation.\n\n**BasicAuth:** Only used when requesting tasks via CalDAV.\n\u003c!-- ReDoc-Inject: \u003csecurity-definitions\u003e --\u003e",
"description": "# Pagination\nEvery endpoint capable of pagination will return two headers:\n* `x-pagination-total-pages`: The total number of available pages for this request\n* `x-pagination-result-count`: The number of items returned for this request.\n# Permissions\nAll endpoints which return a single item (project, task, etc.) - no array - will also return a `x-max-permission` header with the max permission the user has on this item as an int where `0` is `Read Only`, `1` is `Read \u0026 Write` and `2` is `Admin`.\nThis can be used to show or hide ui elements based on the permissions the user has.\n# Errors\nAll errors have an error code and a human-readable error message in addition to the http status code. You should always check for the status code in the response, not only the http status code.\nDue to limitations in the swagger library we're using for this document, only one error per http status code is documented here. Make sure to check the [error docs](https://vikunja.io/docs/errors/) in Vikunja's documentation for a full list of available error codes.\n# Authorization\n**JWT-Auth:** Main authorization method, used for most of the requests. Needs `Authorization: Bearer \u003cjwt-token\u003e`-header to authenticate successfully.\n\n**API Token:** You can create scoped API tokens for your user and use the token to make authenticated requests in the context of that user. The token must be provided via an `Authorization: Bearer \u003ctoken\u003e` header, similar to jwt auth. See the documentation for the `api` group to manage token creation and revocation.\n\n**BasicAuth:** Only used when requesting tasks via CalDAV.\n\u003c!-- ReDoc-Inject: \u003csecurity-definitions\u003e --\u003e",
"title": "Vikunja API",
"contact": {
"name": "General Vikunja contact",
@@ -1409,7 +1409,7 @@
},
{
"type": "string",
"description": "If set to `rights`, Vikunja will return the max right the current user has on this project. You can currently only set this to `rights`.",
"description": "If set to `permissions`, Vikunja will return the max permission the current user has on this project. You can currently only set this to `permissions`.",
"name": "expand",
"in": "query"
}
@@ -1939,7 +1939,7 @@
}
},
"401": {
"description": "The user does not have the right to see the project.",
"description": "The user does not have the permission to see the project.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
@@ -2064,16 +2064,16 @@
],
"responses": {
"200": {
"description": "The teams with their right.",
"description": "The teams with their permission.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.TeamWithRight"
"$ref": "#/definitions/models.TeamWithPermission"
}
}
},
"403": {
"description": "No right to see the project.",
"description": "No permission to see the project.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
@@ -2202,16 +2202,16 @@
],
"responses": {
"200": {
"description": "The users with the right they have.",
"description": "The users with the permission they have.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.UserWithRight"
"$ref": "#/definitions/models.UserWithPermission"
}
}
},
"403": {
"description": "No right to see the project.",
"description": "No permission to see the project.",
"schema": {
"$ref": "#/definitions/web.HTTPError"
}
@@ -2753,7 +2753,7 @@
"JWTKeyAuth": []
}
],
"description": "Copies the project, tasks, files, kanban data, assignees, comments, attachments, labels, 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.",
"description": "Copies the project, tasks, files, kanban data, assignees, comments, attachments, labels, relations, backgrounds, user/team permissions 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"
],
@@ -2817,7 +2817,7 @@
"JWTKeyAuth": []
}
],
"description": "Update a team \u003c-\u003e project relation. Mostly used to update the right that team has.",
"description": "Update a team \u003c-\u003e project relation. Mostly used to update the permission that team has.",
"consumes": [
"application/json"
],
@@ -2945,7 +2945,7 @@
"JWTKeyAuth": []
}
],
"description": "Update a user \u003c-\u003e project relation. Mostly used to update the right that user has.",
"description": "Update a user \u003c-\u003e project relation. Mostly used to update the permission that user has.",
"consumes": [
"application/json"
],
@@ -5276,7 +5276,7 @@
"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.",
"description": "Creates a new relation between two tasks. The user needs to have update permissions on the base task and at least read permissions 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"
],
@@ -5950,7 +5950,7 @@
],
"responses": {
"200": {
"description": "The member right was successfully changed.",
"description": "The member permission was successfully changed.",
"schema": {
"$ref": "#/definitions/models.Message"
}
@@ -8256,13 +8256,13 @@
"description": "The password of this link share. You can only set it, not retrieve it after the link share has been created.",
"type": "string"
},
"right": {
"description": "The right this project is shared with. 0 = Read only, 1 = Read \u0026 Write, 2 = Admin. See the docs for more details.",
"permission": {
"description": "The permission this project is shared with. 0 = Read only, 1 = Read \u0026 Write, 2 = Admin. See the docs for more details.",
"default": 0,
"maximum": 2,
"allOf": [
{
"$ref": "#/definitions/models.Right"
"$ref": "#/definitions/models.Permission"
}
]
},
@@ -8299,6 +8299,19 @@
}
}
},
"models.Permission": {
"type": "integer",
"enum": [
0,
1,
2
],
"x-enum-varnames": [
"PermissionRead",
"PermissionWrite",
"PermissionAdmin"
]
},
"models.Project": {
"type": "object",
"properties": {
@@ -8340,8 +8353,8 @@
"description": "True if a project is a favorite. Favorite projects show up in a separate parent project. This value depends on the user making the call to the api.",
"type": "boolean"
},
"max_right": {
"$ref": "#/definitions/models.Right"
"max_permission": {
"$ref": "#/definitions/models.Permission"
},
"owner": {
"description": "The user who created this project.",
@@ -8412,13 +8425,13 @@
"description": "The unique, numeric id of this project \u003c-\u003e user relation.",
"type": "integer"
},
"right": {
"description": "The right this user has. 0 = Read only, 1 = Read \u0026 Write, 2 = Admin. See the docs for more details.",
"permission": {
"description": "The permission this user has. 0 = Read only, 1 = Read \u0026 Write, 2 = Admin. See the docs for more details.",
"default": 0,
"maximum": 2,
"allOf": [
{
"$ref": "#/definitions/models.Right"
"$ref": "#/definitions/models.Permission"
}
]
},
@@ -8598,19 +8611,6 @@
"ReminderRelationEndDate"
]
},
"models.Right": {
"type": "integer",
"enum": [
0,
1,
2
],
"x-enum-varnames": [
"RightRead",
"RightWrite",
"RightAdmin"
]
},
"models.RouteDetail": {
"type": "object",
"properties": {
@@ -9152,13 +9152,13 @@
"description": "The unique, numeric id of this project \u003c-\u003e team relation.",
"type": "integer"
},
"right": {
"description": "The right this team has. 0 = Read only, 1 = Read \u0026 Write, 2 = Admin. See the docs for more details.",
"permission": {
"description": "The permission this team has. 0 = Read only, 1 = Read \u0026 Write, 2 = Admin. See the docs for more details.",
"default": 0,
"maximum": 2,
"allOf": [
{
"$ref": "#/definitions/models.Right"
"$ref": "#/definitions/models.Permission"
}
]
},
@@ -9208,7 +9208,7 @@
}
}
},
"models.TeamWithRight": {
"models.TeamWithPermission": {
"type": "object",
"properties": {
"created": {
@@ -9257,8 +9257,8 @@
"maxLength": 250,
"minLength": 1
},
"right": {
"$ref": "#/definitions/models.Right"
"permission": {
"$ref": "#/definitions/models.Permission"
},
"updated": {
"description": "A timestamp when this relation was last updated. You cannot change this value.",
@@ -9266,7 +9266,7 @@
}
}
},
"models.UserWithRight": {
"models.UserWithPermission": {
"type": "object",
"properties": {
"created": {
@@ -9286,8 +9286,8 @@
"description": "The full name of the user.",
"type": "string"
},
"right": {
"$ref": "#/definitions/models.Right"
"permission": {
"$ref": "#/definitions/models.Permission"
},
"updated": {
"description": "A timestamp when this task was last updated. You cannot change this value.",

103
pkg/swagger/swagger.yaml
View File

@@ -401,12 +401,12 @@ definitions:
description: The password of this link share. You can only set it, not retrieve
it after the link share has been created.
type: string
right:
permission:
allOf:
- $ref: '#/definitions/models.Right'
- $ref: '#/definitions/models.Permission'
default: 0
description: The right this project is shared with. 0 = Read only, 1 = Read
& Write, 2 = Admin. See the docs for more details.
description: The permission this project is shared with. 0 = Read only, 1
= Read & Write, 2 = Admin. See the docs for more details.
maximum: 2
shared_by:
allOf:
@@ -430,6 +430,16 @@ definitions:
description: A standard message.
type: string
type: object
models.Permission:
enum:
- 0
- 1
- 2
type: integer
x-enum-varnames:
- PermissionRead
- PermissionWrite
- PermissionAdmin
models.Project:
properties:
background_blur_hash:
@@ -468,8 +478,8 @@ definitions:
a separate parent project. This value depends on the user making the call
to the api.
type: boolean
max_right:
$ref: '#/definitions/models.Right'
max_permission:
$ref: '#/definitions/models.Permission'
owner:
allOf:
- $ref: '#/definitions/user.User'
@@ -519,12 +529,12 @@ definitions:
id:
description: The unique, numeric id of this project <-> user relation.
type: integer
right:
permission:
allOf:
- $ref: '#/definitions/models.Right'
- $ref: '#/definitions/models.Permission'
default: 0
description: The right this user has. 0 = Read only, 1 = Read & Write, 2 =
Admin. See the docs for more details.
description: The permission this user has. 0 = Read only, 1 = Read & Write,
2 = Admin. See the docs for more details.
maximum: 2
updated:
description: A timestamp when this relation was last updated. You cannot change
@@ -667,16 +677,6 @@ definitions:
- ReminderRelationDueDate
- ReminderRelationStartDate
- ReminderRelationEndDate
models.Right:
enum:
- 0
- 1
- 2
type: integer
x-enum-varnames:
- RightRead
- RightWrite
- RightAdmin
models.RouteDetail:
properties:
method:
@@ -1101,12 +1101,12 @@ definitions:
id:
description: The unique, numeric id of this project <-> team relation.
type: integer
right:
permission:
allOf:
- $ref: '#/definitions/models.Right'
- $ref: '#/definitions/models.Permission'
default: 0
description: The right this team has. 0 = Read only, 1 = Read & Write, 2 =
Admin. See the docs for more details.
description: The permission this team has. 0 = Read only, 1 = Read & Write,
2 = Admin. See the docs for more details.
maximum: 2
team_id:
description: The team id.
@@ -1146,7 +1146,7 @@ definitions:
minLength: 1
type: string
type: object
models.TeamWithRight:
models.TeamWithPermission:
properties:
created:
description: A timestamp when this relation was created. You cannot change
@@ -1184,14 +1184,14 @@ definitions:
maxLength: 250
minLength: 1
type: string
right:
$ref: '#/definitions/models.Right'
permission:
$ref: '#/definitions/models.Permission'
updated:
description: A timestamp when this relation was last updated. You cannot change
this value.
type: string
type: object
models.UserWithRight:
models.UserWithPermission:
properties:
created:
description: A timestamp when this task was created. You cannot change this
@@ -1207,8 +1207,8 @@ definitions:
name:
description: The full name of the user.
type: string
right:
$ref: '#/definitions/models.Right'
permission:
$ref: '#/definitions/models.Permission'
updated:
description: A timestamp when this task was last updated. You cannot change
this value.
@@ -1634,9 +1634,9 @@ info:
Every endpoint capable of pagination will return two headers:
* `x-pagination-total-pages`: The total number of available pages for this request
* `x-pagination-result-count`: The number of items returned for this request.
# Rights
All endpoints which return a single item (project, task, etc.) - no array - will also return a `x-max-right` header with the max right the user has on this item as an int where `0` is `Read Only`, `1` is `Read & Write` and `2` is `Admin`.
This can be used to show or hide ui elements based on the rights the user has.
# Permissions
All endpoints which return a single item (project, task, etc.) - no array - will also return a `x-max-permission` header with the max permission the user has on this item as an int where `0` is `Read Only`, `1` is `Read & Write` and `2` is `Admin`.
This can be used to show or hide ui elements based on the permissions the user has.
# Errors
All errors have an error code and a human-readable error message in addition to the http status code. You should always check for the status code in the response, not only the http status code.
Due to limitations in the swagger library we're using for this document, only one error per http status code is documented here. Make sure to check the [error docs](https://vikunja.io/docs/errors/) in Vikunja's documentation for a full list of available error codes.
@@ -2718,8 +2718,9 @@ paths:
in: query
name: is_archived
type: boolean
- description: If set to `rights`, Vikunja will return the max right the current
user has on this project. You can currently only set this to `rights`.
- description: If set to `permissions`, Vikunja will return the max permission
the current user has on this project. You can currently only set this to
`permissions`.
in: query
name: expand
type: string
@@ -3067,7 +3068,7 @@ paths:
schema:
$ref: '#/definitions/web.HTTPError'
"401":
description: The user does not have the right to see the project.
description: The user does not have the permission to see the project.
schema:
$ref: '#/definitions/web.HTTPError'
"500":
@@ -3149,13 +3150,13 @@ paths:
- application/json
responses:
"200":
description: The teams with their right.
description: The teams with their permission.
schema:
items:
$ref: '#/definitions/models.TeamWithRight'
$ref: '#/definitions/models.TeamWithPermission'
type: array
"403":
description: No right to see the project.
description: No permission to see the project.
schema:
$ref: '#/definitions/web.HTTPError'
"500":
@@ -3240,13 +3241,13 @@ paths:
- application/json
responses:
"200":
description: The users with the right they have.
description: The users with the permission they have.
schema:
items:
$ref: '#/definitions/models.UserWithRight'
$ref: '#/definitions/models.UserWithPermission'
type: array
"403":
description: No right to see the project.
description: No permission to see the project.
schema:
$ref: '#/definitions/web.HTTPError'
"500":
@@ -4019,9 +4020,9 @@ paths:
consumes:
- application/json
description: Copies the project, tasks, files, kanban data, assignees, comments,
attachments, labels, 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.
attachments, labels, relations, backgrounds, user/team permissions 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.
parameters:
- description: The project ID to duplicate
in: path
@@ -4100,7 +4101,7 @@ paths:
post:
consumes:
- application/json
description: Update a team <-> project relation. Mostly used to update the right
description: Update a team <-> project relation. Mostly used to update the permission
that team has.
parameters:
- description: Project ID
@@ -4185,7 +4186,7 @@ paths:
post:
consumes:
- application/json
description: Update a user <-> project relation. Mostly used to update the right
description: Update a user <-> project relation. Mostly used to update the permission
that user has.
parameters:
- description: Project ID
@@ -5329,9 +5330,9 @@ paths:
consumes:
- application/json
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.
update permissions on the base task and at least read permissions 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.
parameters:
- description: The relation object
in: body
@@ -5760,7 +5761,7 @@ paths:
- application/json
responses:
"200":
description: The member right was successfully changed.
description: The member permission was successfully changed.
schema:
$ref: '#/definitions/models.Message'
"500":