freaktechnik
/
api
forked from vikunja/vikunja
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
api/docs/content/doc/usage/errors.md

135 lines
5.1 KiB
Markdown
Raw Normal View History

Huge improvements for docs (#58)
2019-02-17 19:53:04 +00:00
---
date: "2019-02-12:00:00+02:00"
title: "Errors"
draft: false
type: "doc"
menu:
sidebar:
parent: "usage"
---
added docs for error codes
2018-10-06 16:32:33 +00:00
# Errors
This document describes the different errors Vikunja can return.
Add categories to error docs
2020-04-19 12:33:51 +00:00
### Generic
added docs for error codes
2018-10-06 16:32:33 +00:00
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
Sharing of lists via public links (#94)
2019-08-31 20:56:41 +00:00
| 0001 | 403 | Generic forbidden error. |
Add categories to error docs
2020-04-19 12:33:51 +00:00
### User
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
added docs for error codes
2018-10-06 16:32:33 +00:00
| 1001 | 400 | A user with this username already exists. |
| 1002 | 400 | A user with this email address already exists. |
| 1004 | 400 | No username and password specified. |
| 1005 | 404 | The user does not exist. |
| 1006 | 400 | Could not get the user id. |
Add password reset (#3)
2018-10-27 09:33:28 +00:00
| 1008 | 412 | No password reset token provided. |
| 1009 | 412 | Invalid password reset token. |
Prevent login from inactive (aka non-verified) users (#8)
2018-11-01 22:47:41 +00:00
| 1010 | 412 | Invalid email confirm token. |
| 1011 | 412 | Wrong username or password. |
| 1012 | 412 | Email address of the user not confirmed. |
Integration tests (#71)
2019-04-21 18:18:17 +00:00
| 1013 | 412 | New password is empty. |
| 1014 | 412 | Old password is empty. |
Add 2fa for authentification (#383) Fix user tests Add swagger docs Fix lint Add totp check when logging in Make totp enrollment work Add migration for totp table go mod vendor Add routes for totp routes Add route handler for totp routes Add basic implementation to enroll a user in totp Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/383
2020-04-17 19:25:35 +00:00
| 1015 | 412 | Totp is already enabled for this user. |
| 1016 | 412 | Totp is not enabled for this user. |
| 1017 | 412 | The provided Totp passcode is invalid. |
More avatar providers (#622) Don't fail if the last avatar file does not exist when deleting it Fix lint Remove old global avatar setting and update docs Generate docs Invalidate the avatar cache when uploading a new one Add debug logs Add caching for upload avatars Add cache locks Fix encoding Resize the uploaded image to a max of 1024 pixels Remove the old uploaded avatar if one already exists Add mimetype check for images Set avatar provider to upload when uploading an avatar Add upload avatar provider Make font size smaller to let the initials still look good in smaller sizes Add debug log Add cache and resizing of initials avatars Make font size depend on avatar size Add drawing initials avatar Add initials provider Make the initials avatar provider the default Add routes Add user avatar settings handler methods Add user avatar provider field Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/622
2020-08-02 17:16:58 +00:00
| 1018 | 412 | The provided user avatar provider type setting is invalid. |
Add categories to error docs
2020-04-19 12:33:51 +00:00
### Validation
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
added docs for error codes
2018-10-06 16:32:33 +00:00
| 2001 | 400 | ID cannot be empty or 0. |
Added validation for structs (#19)
2018-11-16 23:17:37 +00:00
| 2002 | 400 | Some of the request data was invalid. The response contains an aditional array with all invalid fields. |
Add categories to error docs
2020-04-19 12:33:51 +00:00
### List
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
added docs for error codes
2018-10-06 16:32:33 +00:00
| 3001 | 404 | The list does not exist. |
| 3004 | 403 | The user needs to have read permissions on that list to perform that action. |
| 3005 | 400 | The list title cannot be empty. |
Sharing of lists via public links (#94)
2019-08-31 20:56:41 +00:00
| 3006 | 404 | The list share does not exist. |
Add task identifier (#115)
2019-12-07 22:28:45 +00:00
| 3007 | 400 | A list with this identifier already exists. |
Add support for archiving lists and namespaces (#152) Add query param to get all lists including archived ones Add query param to get all namespaces including archived ones Fix getting lists by namespace only not archived lists Fix misspell Fix lint Merge branch 'master' into feature/archive-lists-namespaces Add docs for error codes Fix archive error codes Don't let archived lists show up in general lists Fix updating description Fix updating lists with link shares More comments Fix un-archiving lists Move check for archiving a list to canWrite Check Add more tests Add more checks Add checks for namespaces and lists Add namespace edit Add tests Add migrations and filter Add basic tests Add is archived property to lists and namespaces Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/152
2020-03-15 21:50:39 +00:00
| 3008 | 412 | The list is archived and can therefore only be accessed read only. This is also true for all tasks associated with this list. |
Add categories to error docs
2020-04-19 12:33:51 +00:00
### Task
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
added docs for error codes
2018-10-06 16:32:33 +00:00
| 4001 | 400 | The list task text cannot be empty. |
| 4002 | 404 | The list task does not exist. |
Add bulk edit for tasks (#42)
2018-12-28 21:49:46 +00:00
| 4003 | 403 | All bulk editing tasks must belong to the same list. |
| 4004 | 403 | Need at least one task when bulk editing tasks. |
Add labels to tasks (#45)
2018-12-31 01:18:41 +00:00
| 4005 | 403 | The user does not have the right to see the task. |
Task Relations (#103)
2019-09-25 18:44:41 +00:00
| 4006 | 403 | The user tried to set a parent task as the task itself. |
| 4007 | 400 | The user tried to create a task relation with an invalid kind of relation. |
| 4008 | 409 | The user tried to create a task relation which already exists. |
| 4009 | 404 | The task relation does not exist. |
| 4010 | 400 | Cannot relate a task with itself. |
Task Attachments (#104)
2019-10-16 20:52:29 +00:00
| 4011 | 404 | The task attachment does not exist. |
| 4012 | 400 | The task attachment is too large. |
Sort Order for tasks (#110)
2019-12-07 14:30:51 +00:00
| 4013 | 400 | The task sort param is invalid. |
| 4014 | 400 | The task sort order is invalid. |
Task Comments (#138) Add swagger docs Add integration tests Add tests Add task comment test fixtures Add config option to enable/disable task comments Add custom error if a task comment does not exist Fix lint Add getting author when getting a single comment Fix getting comments/comments author Add rights check to ReadAll + actually get the comment author Add migration and table definitions Add routes Add ReadOne method Add basic crud rights Signed-off-by: kolaente <k@knt.li> Implement basic crudable functions for task comments Signed-off-by: kolaente <k@knt.li> Start adding task comments Signed-off-by: kolaente <k@knt.li> Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/138
2020-02-19 21:57:56 +00:00
| 4015 | 404 | The task comment does not exist. |
Task filters (#243) Fix not returning errors Fix integration tests Add more tests Make task filtering actually work Change tests Fix using filter conditions Fix test Remove unused fields Fix static check Remove start and end date fields on task collection Fix misspell add filter logic when getting tasks Add parsing filter query parameters into task filters Start adding support for filters Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/243
2020-04-11 14:20:33 +00:00
| 4016 | 403 | Invalid task field. |
| 4017 | 403 | Invalid task filter comparator. |
Task Filter Fixes (#495) Fix gocyclo Fix misspell Error codes docs Filter fixes Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/495
2020-05-09 15:48:56 +00:00
| 4018 | 403 | Invalid task filter concatinator. |
Migrate all timestamps to real iso dates (#594) Fix query param name Add option to include null results when filtering Always set db time to gmt Fix null filter Fix timezone setting for todoist parsing Fix timezone setting for wunderlist parsing Fix import Fix caldav reminder parsing Use timezone from config Add error and test for invalid filter values Fix integration tests Remove task collection date hack Fix task filter Fix lint Fix tests and fixtures for date timezone stuff Properly set timezone Change fixtures time zone to gmt Set db timezone Set created and updated timestamps for all fixtures Fix lint Fix test fixtures Fix misspell Fix test fixtures Partially fix tests Remove timeutil package Remove adding _unix suffix hack Remove _unix suffix Move all timeutil.TimeStamp to time.Time Remove all Unix suffixes in field names Add better error messages when running migrations Make sure to not migrate 0 unix timestamps to 1970 iso dates Add migration script for sqlite Add converting sqlite values Convert 0 unix timestamps to null in postgres Convert 0 to null in timestamps Automatically rename _unix suffix Add all tables and columns for migration Fix sql migration query for mysql Fail with an error if trying to use an unsupported dbms Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/594
2020-06-27 17:04:01 +00:00
| 4019 | 403 | Invalid task filter value. |
Add categories to error docs
2020-04-19 12:33:51 +00:00
### Namespace
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
added docs for error codes
2018-10-06 16:32:33 +00:00
| 5001 | 404 | The namspace does not exist. |
| 5003 | 403 | The user does not have access to the specified namespace. |
| 5006 | 400 | The namespace name cannot be empty. |
| 5009 | 403 | The user needs to have namespace read access to perform that action. |
| 5010 | 403 | This team does not have access to that namespace. |
| 5011 | 409 | This user has already access to that namespace. |
Add support for archiving lists and namespaces (#152) Add query param to get all lists including archived ones Add query param to get all namespaces including archived ones Fix getting lists by namespace only not archived lists Fix misspell Fix lint Merge branch 'master' into feature/archive-lists-namespaces Add docs for error codes Fix archive error codes Don't let archived lists show up in general lists Fix updating description Fix updating lists with link shares More comments Fix un-archiving lists Move check for archiving a list to canWrite Check Add more tests Add more checks Add checks for namespaces and lists Add namespace edit Add tests Add migrations and filter Add basic tests Add is archived property to lists and namespaces Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/152
2020-03-15 21:50:39 +00:00
| 5012 | 412 | The namespace is archived and can therefore only be accessed read only. |
Add categories to error docs
2020-04-19 12:33:51 +00:00
### Team
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
added docs for error codes
2018-10-06 16:32:33 +00:00
| 6001 | 400 | The team name cannot be emtpy. |
| 6002 | 404 | The team does not exist. |
| 6004 | 409 | The team already has access to that namespace or list. |
| 6005 | 409 | The user is already a member of that team. |
| 6006 | 400 | Cannot delete the last team member. |
| 6007 | 403 | The team does not have access to the list to perform that action. |
Add categories to error docs
2020-04-19 12:33:51 +00:00
### User List Access
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
added docs for error codes
2018-10-06 16:32:33 +00:00
| 7002 | 409 | The user already has access to that list. |
| 7003 | 403 | The user does not have access to that list. |
Add categories to error docs
2020-04-19 12:33:51 +00:00
### Label
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
Add labels to tasks (#45)
2018-12-31 01:18:41 +00:00
| 8001 | 403 | This label already exists on that task. |
Improve label handling (#48)
2019-01-09 23:08:12 +00:00
| 8002 | 404 | The label does not exist. |
Rights performance improvements for lists and namespaces (#54)
2019-01-21 22:08:04 +00:00
| 8003 | 403 | The user does not have access to this label. |
Add categories to error docs
2020-04-19 12:33:51 +00:00
### Right
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
Kanban (#393) Fix tests Add error docs Add swagger docs for bucket endpoints Add integration tests Fix tests Fix err shadow Make sure a bucket and a task belong to the same list when adding or updating a task Add tests Add getting users of a bucket Fix log level when testing Fix lint Add migration for buckets Cleanup/Comments/Reorganization Add Kanban bucket handling Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/393
2020-04-19 07:27:28 +00:00
| 9001 | 403 | The right is invalid. |
Add categories to error docs
2020-04-19 12:33:51 +00:00
### Kanban
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
Kanban (#393) Fix tests Add error docs Add swagger docs for bucket endpoints Add integration tests Fix tests Fix err shadow Make sure a bucket and a task belong to the same list when adding or updating a task Add tests Add getting users of a bucket Fix log level when testing Fix lint Add migration for buckets Cleanup/Comments/Reorganization Add Kanban bucket handling Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/393
2020-04-19 07:27:28 +00:00
| 10001 | 404 | The bucket does not exist. |
| 10002 | 400 | The bucket does not belong to that list. |
Add real buckets for tasks which don't have one (#446) Add docs for error code Add moving new tasks into the default bucket when none was provided Add moving tasks in default bucket when deleting one Fix tests again Add test for removing a bucket Fix tests Prevent removing the last bucket Remove the empty pseudo bucket Add migration to create a new bucket for each list (and put all tasks in it Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/446
2020-04-25 20:32:02 +00:00
| 10003 | 412 | You cannot remove the last bucket on a list. |