local-it/vikunja-api
0
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
vikunja-api/pkg/swagger/swagger.yaml

5341 lines
155 KiB
YAML
Raw Normal View History

Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
basePath: /api/v1
definitions:
Authentication with OpenID Connect providers (#713) Add config docs Lint Move provider-related stuff to separate file Refactor getting auth providers Fix tests Fix user tests Fix openid tests Add swagger docs Fix lint Fix lint issues Fix checking if the user already exists Make sure to create a new namespace for new users Docs Add tests for openid Remove unnessecary err check Consistently return nil users if creating a new user failed Move sending confirmation email to separate function Better variable names Move checks to separate functions Refactor creating user into seperate file Fix creating new local users Test creating new users from different issuers Generate a random username right away if no preferred username has been given Add todo Cache openid providers Add getting int clientids Fix migration Move creating tokens to auth package Add getting or creating a third party user Add parsing claims Add retreiving auth tokens Add token callback from openid package Add check for provider key Add routes Start adding openid auth handler Add config for openid auth Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/713 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-11-21 17:38:58 +01:00
auth.Token:
properties:
token:
type: string
type: object
Fix swagger docs
2020-06-28 16:25:46 +02:00
background.Image:
properties:
id:
type: string
info:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: This can be used to supply extra information from an image provider to clients
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: object
thumb:
type: string
url:
type: string
type: object
Task Attachments (#104)
2019-10-16 22:52:29 +02:00
files.File:
properties:
created:
type: string
id:
type: integer
mime:
type: string
name:
type: string
size:
type: integer
type: object
Migration (#120) Go mod tidy [skip ci] Add modules/migration to docs [skip ci] update date fmt Merge branch 'master' into feature/migration # Conflicts: # pkg/routes/api/v1/info.go Add docs on how to create a migrator Add available migrators to /info endpoint Return a message once everything was migrated successfully Add swagger docs for wunderlist migration Docs for migration [skip ci] Fix due date fixture in migration test Fix staticcheck Fix lint Logging and cleanup Make the migrator work with real data Add routes for migration Fix misspell Add method to store a full vikunja structure into vikunja Add getting all data from wunderlist Add attachment migration from wunderlist Add done and done at to wunderlist migrator Add todo Add wunderlist auth url implementation Fix lint Finish wunderlist migration Added all structs for the wunderlist migratior Fix owner field being null for user shared namespaces (#119) Update copyright year (#118) Add option to disable registration (#117) Added migrator interface Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/120
2020-01-19 17:52:16 +01:00
handler.AuthURL:
properties:
url:
type: string
type: object
Add Microsoft Todo migration (#737) Add more logs Fix lint Generate docs Add swagger docs Add microsoft todo parsing logic go mod tidy Add basic test structure Add more fields to tasks rename microsoft todo package Add getting microsoft todo data Add structs and helper methods Add microsoft todo config and routes Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/737 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-12-18 12:12:05 +01:00
microsofttodo.Migration:
properties:
code:
type: string
type: object
Migration Improvements (#122) Update swagger docs Update docs Let the wunderlist migrator use the registerRoutes function Add migration status table Add migration status Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/122
2020-01-20 20:48:46 +01:00
migration.Status:
properties:
id:
type: integer
migrator_name:
type: string
Fix swagger docs
2020-06-28 16:25:46 +02:00
time:
type: string
Migration Improvements (#122) Update swagger docs Update docs Let the wunderlist migrator use the registerRoutes function Add migration status table Add migration status Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/122
2020-01-20 20:48:46 +01:00
type: object
Fix swagger docs
2020-06-28 16:25:46 +02:00
models.Bucket:
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
properties:
Fix swagger docs
2020-06-28 16:25:46 +02:00
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this bucket was created. You cannot change this value.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
Fix swagger docs
2020-06-28 16:25:46 +02:00
created_by:
$ref: '#/definitions/user.User'
description: The user who initially created the bucket.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
id:
Fix swagger docs
2020-06-28 16:25:46 +02:00
description: The unique, numeric id of this bucket.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
Kanban bucket limits (#652) Fix integration tests Generate swagger docs Add test for moving a task between buckets Add check for bucket limit when updating a task Add fixture to ensure a bucket with a high limit will never exceed the limit Refactor bucket limit check into seperate function Add test for creating and fix Fix unexported field Add error in case a task was added to a bucket which has its limit already exceeded Add migration to add new task field Add limit field to buckets Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/652
2020-09-04 16:37:56 +02:00
limit:
description: How many tasks can be at the same time on this board max
type: integer
Fix swagger docs
2020-06-28 16:25:46 +02:00
list_id:
description: The list this bucket belongs to.
type: integer
tasks:
description: All tasks which belong to this bucket.
items:
$ref: '#/definitions/models.Task'
type: array
title:
description: The title of this bucket.
minLength: 1
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
Fix swagger docs
2020-06-28 16:25:46 +02:00
updated:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this bucket was last updated. You cannot change this value.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
type: object
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
models.BulkAssignees:
properties:
assignees:
description: A list with all assignees
items:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/user.User'
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
type: array
type: object
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
models.BulkTask:
properties:
Task assignees (#44)
2018-12-29 15:29:50 +01:00
assignees:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: An array of users who are assigned to this task
Task assignees (#44)
2018-12-29 15:29:50 +01:00
items:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/user.User'
Task assignees (#44)
2018-12-29 15:29:50 +01:00
type: array
Task Attachments (#104)
2019-10-16 22:52:29 +02:00
attachments:
description: All attachments this task has
items:
$ref: '#/definitions/models.TaskAttachment'
type: array
Fix swagger docs
2020-06-28 16:25:46 +02:00
bucket_id:
description: BucketID is the ID of the kanban bucket this task belongs to.
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
type: integer
Fix swagger docs
2020-06-28 16:25:46 +02:00
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this task was created. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
created_by:
$ref: '#/definitions/user.User'
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The user who initially created the task.
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
description:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The task description.
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
type: string
done:
Refactor {List|Namespace}{User|Team} to not expose unneded values via json (#52)
2019-01-14 23:32:56 +01:00
description: Whether a task is done or not.
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
type: boolean
Fix swagger docs
2020-06-28 16:25:46 +02:00
done_at:
description: The time when a task was marked as done.
type: string
due_date:
description: The time when the task is due.
type: string
end_date:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: When this task ends.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
hex_color:
Added color field to tasks
2019-04-30 11:26:37 +02:00
description: The task color in hex
maxLength: 6
type: string
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
id:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The unique, numeric id of this task.
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
type: integer
Add task identifier (#115)
2019-12-07 23:28:45 +01:00
identifier:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: The task identifier, based on the list identifier and the task's index
Add task identifier (#115)
2019-12-07 23:28:45 +01:00
type: string
index:
description: The task index, calculated per list
type: integer
Favorite tasks (#653) Fixed namespace tests Add test for favorite tasks Fix favorite tasks not being updated Fix integration tests Fix lint Return a pseudo namespace and list for favorites Make sure users can only see their favorites Add condition show tasks from the favorites list Regenerate swagger docs Add favorite field to task Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/653
2020-09-05 22:16:02 +02:00
is_favorite:
description: True if a task is a favorite task. Favorite tasks show up in a separate "Important" list
type: boolean
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
labels:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: An array of labels which are associated with this task.
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
items:
$ref: '#/definitions/models.Label'
type: array
Fix swagger docs
2020-06-28 16:25:46 +02:00
list_id:
Fixed listID not being returned in tasks
2019-04-23 21:53:37 +02:00
description: The list this task belongs to.
type: integer
Fix swagger docs
2020-06-28 16:25:46 +02:00
percent_done:
Added percent done to tasks (#102)
2019-09-21 12:52:10 +02:00
description: Determines how far a task is left from being done
type: number
Fix swagger docs
2020-06-28 16:25:46 +02:00
position:
description: |-
The position of the task - any task list can be sorted as usual by this parameter.
When accessing tasks via kanban buckets, this is primarily used to sort them based on a range
We're using a float64 here to make it possible to put any task within any two other tasks (by changing the number).
You would calculate the new position between two tasks with something like task3.position = (task2.position - task1.position) / 2.
A 64-Bit float leaves plenty of room to initially give tasks a position with 2^16 difference to the previous task
which also leaves a lot of room for rearranging and sorting later.
type: number
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
priority:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: The task priority. Can be anything you want, it is possible to sort by this later.
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
type: integer
Task Relations (#103)
2019-09-25 20:44:41 +02:00
related_tasks:
$ref: '#/definitions/models.RelatedTaskMap'
description: All related tasks, grouped by their relation kind
Fix swagger docs
2020-06-28 16:25:46 +02:00
reminder_dates:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: An array of datetimes when the user wants to be reminded of the task.
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
items:
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
type: array
Fix swagger docs
2020-06-28 16:25:46 +02:00
repeat_after:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: An amount in seconds this task repeats itself. If this is set, when marking the task as done, it will mark itself as "undone" and then increase all remindes and the due date by its amount.
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
type: integer
Fix swagger docs
2020-06-28 16:25:46 +02:00
repeat_from_current_date:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: If specified, a repeating task will repeat from the current date rather than the last set date.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: boolean
start_date:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: When this task starts.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
task_ids:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: A list of task ids to update
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
items:
type: integer
type: array
Fix swagger docs
2020-06-28 16:25:46 +02:00
title:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The task text. This is what you'll see in the list.
maxLength: 250
Saved filters (#655) Fix updating saved filters Fix filter not loadable because of missing param declaration Add fancy special cases for postgres exists in db Add special case for postgrs json Add read one test Add rights tests Fix lint Fixed getting a single saved filter from db Add tests for the usual crud methods Add test stubs and TODOs Add test for converting saved filter ids to list ids and vice versa Add test fixture for saved filters and fix existing tests Fix exposed json variables of filters Fix creating saved filters table for tests Add getting saved filters as pseudo namespace Cleanup Refactor getting all namespaces to use a map for easier handling of pseudo namespaces Add custom erros for saved filters Swagger docs Fix lint Add routes for saved filters Add alias for mage build Add method to get a saved filter from the lists endpoint Add getting tasks from a saved filter Add create, update, delete, read one methods Add rights methods for saved filters Fix docs minLength Add saved filters column Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/655 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-09-26 23:02:17 +02:00
minLength: 1
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
type: string
updated:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this task was last updated. You cannot change this value.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
type: object
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
models.Label:
properties:
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this label was created. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
created_by:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/user.User'
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The user who created this label
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
description:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The label description.
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
type: string
hex_color:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The color this label has
maxLength: 6
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
type: string
id:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The unique, numeric id of this label.
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
type: integer
title:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: The title of the lable. You'll see this one on tasks associated with it.
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
maxLength: 250
Saved filters (#655) Fix updating saved filters Fix filter not loadable because of missing param declaration Add fancy special cases for postgres exists in db Add special case for postgrs json Add read one test Add rights tests Fix lint Fixed getting a single saved filter from db Add tests for the usual crud methods Add test stubs and TODOs Add test for converting saved filter ids to list ids and vice versa Add test fixture for saved filters and fix existing tests Fix exposed json variables of filters Fix creating saved filters table for tests Add getting saved filters as pseudo namespace Cleanup Refactor getting all namespaces to use a map for easier handling of pseudo namespaces Add custom erros for saved filters Swagger docs Fix lint Add routes for saved filters Add alias for mage build Add method to get a saved filter from the lists endpoint Add getting tasks from a saved filter Add create, update, delete, read one methods Add rights methods for saved filters Fix docs minLength Add saved filters column Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/655 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-09-26 23:02:17 +02:00
minLength: 1
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
type: string
updated:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this label was last updated. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
type: object
Fixed swagger docs for task labels
2019-03-21 07:40:56 +01:00
models.LabelTask:
properties:
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this task was created. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Fixed swagger docs for task labels
2019-03-21 07:40:56 +01:00
label_id:
description: The label id you want to associate with a task.
type: integer
type: object
Improve label handling (#48)
2019-01-10 00:08:12 +01:00
models.LabelTaskBulk:
properties:
labels:
Fixed swagger docs for bulk label tasks
2019-03-21 18:42:21 +01:00
description: All labels you want to update at once.
Improve label handling (#48)
2019-01-10 00:08:12 +01:00
items:
$ref: '#/definitions/models.Label'
type: array
type: object
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
models.LinkSharing:
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
properties:
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this list was shared. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
hash:
description: The public id to get this shared list
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
id:
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
description: The ID of the shared thing
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
right:
default: 0
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: The right this list is shared with. 0 = Read only, 1 = Read & Write, 2 = Admin. See the docs for more details.
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
maximum: 2
type: integer
shared_by:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/user.User'
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
description: The user who shared this list
sharing_type:
default: 0
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: The kind of this link. 0 = undefined, 1 = without password, 2 = with password (currently not implemented).
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
maximum: 2
type: integer
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
updated:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this share was last updated. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: object
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
models.List:
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
properties:
Fix swagger docs
2020-06-28 16:25:46 +02:00
background_information:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Holds extra information about the background set since some background providers require attribution or similar. If not null, the background can be accessed at /lists/{listID}/background
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: object
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this list was created. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
description:
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
description: The description of the list.
Added color field to tasks
2019-04-30 11:26:37 +02:00
type: string
Fix swagger docs
2020-06-28 16:25:46 +02:00
hex_color:
description: The hex color of this list
maxLength: 6
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
id:
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
description: The unique, numeric id of this list.
Start end end dates for tasks (#40)
2018-12-22 16:45:16 +01:00
type: integer
Add task identifier (#115)
2019-12-07 23:28:45 +01:00
identifier:
description: The unique list short identifier. Used to build task identifiers.
maxLength: 10
minLength: 0
type: string
Fix swagger docs
2020-06-28 16:25:46 +02:00
is_archived:
description: Whether or not a list is archived.
type: boolean
Favorite lists (#654) Add tests Remove the favorites pseudo namespace if there are no lists or tasks favorited Regenerate swagger docs Fix favorite lists not being updated because of nonexisting users (the favorite list does not have one) Make the pseudo favorites list always favorited Add favorited lists to the favorites pseudo namespace Add favorite field to list Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/654
2020-09-06 16:20:16 +02:00
is_favorite:
description: True if a list is a favorite. Favorite lists show up in a separate namespace.
type: boolean
Fix swagger docs
2020-06-28 16:25:46 +02:00
namespace_id:
type: integer
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
owner:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/user.User'
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
description: The user who created this list.
title:
description: The title of the list. You'll see this in the namespace overview.
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
maxLength: 250
Saved filters (#655) Fix updating saved filters Fix filter not loadable because of missing param declaration Add fancy special cases for postgres exists in db Add special case for postgrs json Add read one test Add rights tests Fix lint Fixed getting a single saved filter from db Add tests for the usual crud methods Add test stubs and TODOs Add test for converting saved filter ids to list ids and vice versa Add test fixture for saved filters and fix existing tests Fix exposed json variables of filters Fix creating saved filters table for tests Add getting saved filters as pseudo namespace Cleanup Refactor getting all namespaces to use a map for easier handling of pseudo namespaces Add custom erros for saved filters Swagger docs Fix lint Add routes for saved filters Add alias for mage build Add method to get a saved filter from the lists endpoint Add getting tasks from a saved filter Add create, update, delete, read one methods Add rights methods for saved filters Fix docs minLength Add saved filters column Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/655 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-09-26 23:02:17 +02:00
minLength: 1
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
updated:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this list was last updated. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: object
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 19:16:58 +02:00
models.ListDuplicate:
properties:
list:
$ref: '#/definitions/models.List'
description: The copied list
namespace_id:
description: The target namespace ID
type: integer
type: object
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
models.ListUser:
properties:
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this relation was created. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
id:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The unique, numeric id of this list <-> user relation.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
right:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
default: 0
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: The right this user has. 0 = Read only, 1 = Read & Write, 2 = Admin. See the docs for more details.
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
maximum: 2
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
updated:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this relation was last updated. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
user_id:
Use the username instead of a user when adding a user to a team or giving it rights (#76)
2019-05-25 11:47:16 +02:00
description: The username.
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: object
models.Message:
properties:
message:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: A standard message.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
type: object
models.Namespace:
properties:
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this namespace was created. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
description:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The description of the namespace
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
Fix swagger docs
2020-06-28 16:25:46 +02:00
hex_color:
description: The hex color of this namespace
maxLength: 6
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
id:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The unique, numeric id of this namespace.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
Fix swagger docs
2020-06-28 16:25:46 +02:00
is_archived:
description: Whether or not a namespace is archived.
type: boolean
owner:
$ref: '#/definitions/user.User'
description: The user who owns this namespace
title:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The name of this namespace.
maxLength: 250
Saved filters (#655) Fix updating saved filters Fix filter not loadable because of missing param declaration Add fancy special cases for postgres exists in db Add special case for postgrs json Add read one test Add rights tests Fix lint Fixed getting a single saved filter from db Add tests for the usual crud methods Add test stubs and TODOs Add test for converting saved filter ids to list ids and vice versa Add test fixture for saved filters and fix existing tests Fix exposed json variables of filters Fix creating saved filters table for tests Add getting saved filters as pseudo namespace Cleanup Refactor getting all namespaces to use a map for easier handling of pseudo namespaces Add custom erros for saved filters Swagger docs Fix lint Add routes for saved filters Add alias for mage build Add method to get a saved filter from the lists endpoint Add getting tasks from a saved filter Add create, update, delete, read one methods Add rights methods for saved filters Fix docs minLength Add saved filters column Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/655 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-09-26 23:02:17 +02:00
minLength: 1
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
updated:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this namespace was last updated. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: object
models.NamespaceUser:
properties:
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this relation was created. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
id:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The unique, numeric id of this namespace <-> user relation.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
right:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
default: 0
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: The right this user has. 0 = Read only, 1 = Read & Write, 2 = Admin. See the docs for more details.
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
maximum: 2
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
updated:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this relation was last updated. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
user_id:
Use the username instead of a user when adding a user to a team or giving it rights (#76)
2019-05-25 11:47:16 +02:00
description: The username.
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: object
models.NamespaceWithLists:
properties:
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this namespace was created. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
description:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The description of the namespace
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
Fix swagger docs
2020-06-28 16:25:46 +02:00
hex_color:
description: The hex color of this namespace
maxLength: 6
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
id:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The unique, numeric id of this namespace.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
Fix swagger docs
2020-06-28 16:25:46 +02:00
is_archived:
description: Whether or not a namespace is archived.
type: boolean
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
lists:
items:
$ref: '#/definitions/models.List'
type: array
Fix swagger docs
2020-06-28 16:25:46 +02:00
owner:
$ref: '#/definitions/user.User'
description: The user who owns this namespace
title:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The name of this namespace.
maxLength: 250
Saved filters (#655) Fix updating saved filters Fix filter not loadable because of missing param declaration Add fancy special cases for postgres exists in db Add special case for postgrs json Add read one test Add rights tests Fix lint Fixed getting a single saved filter from db Add tests for the usual crud methods Add test stubs and TODOs Add test for converting saved filter ids to list ids and vice versa Add test fixture for saved filters and fix existing tests Fix exposed json variables of filters Fix creating saved filters table for tests Add getting saved filters as pseudo namespace Cleanup Refactor getting all namespaces to use a map for easier handling of pseudo namespaces Add custom erros for saved filters Swagger docs Fix lint Add routes for saved filters Add alias for mage build Add method to get a saved filter from the lists endpoint Add getting tasks from a saved filter Add create, update, delete, read one methods Add rights methods for saved filters Fix docs minLength Add saved filters column Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/655 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-09-26 23:02:17 +02:00
minLength: 1
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
updated:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this namespace was last updated. You cannot change this value.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
type: object
Task Relations (#103)
2019-09-25 20:44:41 +02:00
models.RelatedTaskMap:
additionalProperties:
items:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/models.Task'
Task Relations (#103)
2019-09-25 20:44:41 +02:00
type: array
type: object
Saved filters (#655) Fix updating saved filters Fix filter not loadable because of missing param declaration Add fancy special cases for postgres exists in db Add special case for postgrs json Add read one test Add rights tests Fix lint Fixed getting a single saved filter from db Add tests for the usual crud methods Add test stubs and TODOs Add test for converting saved filter ids to list ids and vice versa Add test fixture for saved filters and fix existing tests Fix exposed json variables of filters Fix creating saved filters table for tests Add getting saved filters as pseudo namespace Cleanup Refactor getting all namespaces to use a map for easier handling of pseudo namespaces Add custom erros for saved filters Swagger docs Fix lint Add routes for saved filters Add alias for mage build Add method to get a saved filter from the lists endpoint Add getting tasks from a saved filter Add create, update, delete, read one methods Add rights methods for saved filters Fix docs minLength Add saved filters column Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/655 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-09-26 23:02:17 +02:00
models.SavedFilter:
properties:
created:
description: A timestamp when this filter was created. You cannot change this value.
type: string
description:
description: The description of the filter
type: string
filters:
$ref: '#/definitions/models.TaskCollection'
description: The actual filters this filter contains
id:
description: The unique numeric id of this saved filter
type: integer
owner:
$ref: '#/definitions/user.User'
description: The user who owns this filter
title:
description: The title of the filter.
maxLength: 250
minLength: 1
type: string
updated:
description: A timestamp when this filter was last updated. You cannot change this value.
type: string
type: object
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
models.Task:
properties:
assignees:
description: An array of users who are assigned to this task
items:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/user.User'
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
type: array
Task Attachments (#104)
2019-10-16 22:52:29 +02:00
attachments:
description: All attachments this task has
items:
$ref: '#/definitions/models.TaskAttachment'
type: array
Fix swagger docs
2020-06-28 16:25:46 +02:00
bucket_id:
description: BucketID is the ID of the kanban bucket this task belongs to.
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
type: integer
Fix swagger docs
2020-06-28 16:25:46 +02:00
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this task was created. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
created_by:
$ref: '#/definitions/user.User'
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
description: The user who initially created the task.
description:
description: The task description.
type: string
done:
description: Whether a task is done or not.
type: boolean
Fix swagger docs
2020-06-28 16:25:46 +02:00
done_at:
description: The time when a task was marked as done.
type: string
due_date:
description: The time when the task is due.
type: string
end_date:
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
description: When this task ends.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
hex_color:
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
description: The task color in hex
maxLength: 6
type: string
id:
description: The unique, numeric id of this task.
type: integer
Add task identifier (#115)
2019-12-07 23:28:45 +01:00
identifier:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: The task identifier, based on the list identifier and the task's index
Add task identifier (#115)
2019-12-07 23:28:45 +01:00
type: string
index:
description: The task index, calculated per list
type: integer
Favorite tasks (#653) Fixed namespace tests Add test for favorite tasks Fix favorite tasks not being updated Fix integration tests Fix lint Return a pseudo namespace and list for favorites Make sure users can only see their favorites Add condition show tasks from the favorites list Regenerate swagger docs Add favorite field to task Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/653
2020-09-05 22:16:02 +02:00
is_favorite:
description: True if a task is a favorite task. Favorite tasks show up in a separate "Important" list
type: boolean
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
labels:
description: An array of labels which are associated with this task.
items:
$ref: '#/definitions/models.Label'
type: array
Fix swagger docs
2020-06-28 16:25:46 +02:00
list_id:
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
description: The list this task belongs to.
type: integer
Fix swagger docs
2020-06-28 16:25:46 +02:00
percent_done:
Added percent done to tasks (#102)
2019-09-21 12:52:10 +02:00
description: Determines how far a task is left from being done
type: number
Fix swagger docs
2020-06-28 16:25:46 +02:00
position:
description: |-
The position of the task - any task list can be sorted as usual by this parameter.
When accessing tasks via kanban buckets, this is primarily used to sort them based on a range
We're using a float64 here to make it possible to put any task within any two other tasks (by changing the number).
You would calculate the new position between two tasks with something like task3.position = (task2.position - task1.position) / 2.
A 64-Bit float leaves plenty of room to initially give tasks a position with 2^16 difference to the previous task
which also leaves a lot of room for rearranging and sorting later.
type: number
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
priority:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: The task priority. Can be anything you want, it is possible to sort by this later.
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
type: integer
Task Relations (#103)
2019-09-25 20:44:41 +02:00
related_tasks:
$ref: '#/definitions/models.RelatedTaskMap'
description: All related tasks, grouped by their relation kind
Fix swagger docs
2020-06-28 16:25:46 +02:00
reminder_dates:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: An array of datetimes when the user wants to be reminded of the task.
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
items:
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
type: array
Fix swagger docs
2020-06-28 16:25:46 +02:00
repeat_after:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: An amount in seconds this task repeats itself. If this is set, when marking the task as done, it will mark itself as "undone" and then increase all remindes and the due date by its amount.
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
type: integer
Fix swagger docs
2020-06-28 16:25:46 +02:00
repeat_from_current_date:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: If specified, a repeating task will repeat from the current date rather than the last set date.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: boolean
start_date:
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
description: When this task starts.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
title:
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
description: The task text. This is what you'll see in the list.
maxLength: 250
Saved filters (#655) Fix updating saved filters Fix filter not loadable because of missing param declaration Add fancy special cases for postgres exists in db Add special case for postgrs json Add read one test Add rights tests Fix lint Fixed getting a single saved filter from db Add tests for the usual crud methods Add test stubs and TODOs Add test for converting saved filter ids to list ids and vice versa Add test fixture for saved filters and fix existing tests Fix exposed json variables of filters Fix creating saved filters table for tests Add getting saved filters as pseudo namespace Cleanup Refactor getting all namespaces to use a map for easier handling of pseudo namespaces Add custom erros for saved filters Swagger docs Fix lint Add routes for saved filters Add alias for mage build Add method to get a saved filter from the lists endpoint Add getting tasks from a saved filter Add create, update, delete, read one methods Add rights methods for saved filters Fix docs minLength Add saved filters column Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/655 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-09-26 23:02:17 +02:00
minLength: 1
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
type: string
updated:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this task was last updated. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
type: object
models.TaskAssginee:
properties:
created:
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
user_id:
type: integer
type: object
Task Attachments (#104)
2019-10-16 22:52:29 +02:00
models.TaskAttachment:
properties:
created:
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Task Attachments (#104)
2019-10-16 22:52:29 +02:00
created_by:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/user.User'
Task Attachments (#104)
2019-10-16 22:52:29 +02:00
file:
$ref: '#/definitions/files.File'
id:
type: integer
task_id:
type: integer
type: object
Saved filters (#655) Fix updating saved filters Fix filter not loadable because of missing param declaration Add fancy special cases for postgres exists in db Add special case for postgrs json Add read one test Add rights tests Fix lint Fixed getting a single saved filter from db Add tests for the usual crud methods Add test stubs and TODOs Add test for converting saved filter ids to list ids and vice versa Add test fixture for saved filters and fix existing tests Fix exposed json variables of filters Fix creating saved filters table for tests Add getting saved filters as pseudo namespace Cleanup Refactor getting all namespaces to use a map for easier handling of pseudo namespaces Add custom erros for saved filters Swagger docs Fix lint Add routes for saved filters Add alias for mage build Add method to get a saved filter from the lists endpoint Add getting tasks from a saved filter Add create, update, delete, read one methods Add rights methods for saved filters Fix docs minLength Add saved filters column Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/655 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-09-26 23:02:17 +02:00
models.TaskCollection:
properties:
filter_by:
description: The field name of the field to filter by
items:
type: string
type: array
filter_comparator:
description: The comparator for field and value
items:
type: string
type: array
filter_concat:
description: The way all filter conditions are concatenated together, can be either "and" or "or".,
type: string
filter_include_nulls:
description: If set to true, the result will also include null values
type: boolean
filter_value:
description: The value of the field name to filter by
items:
type: string
type: array
order_by:
description: The query parameter to order the items by. This can be either asc or desc, with asc being the default.
items:
type: string
type: array
sort_by:
description: The query parameter to sort by. This is for ex. done, priority, etc.
items:
type: string
type: array
type: object
Fix swagger docs
2020-06-28 16:25:46 +02:00
models.TaskComment:
Task Relations (#103)
2019-09-25 20:44:41 +02:00
properties:
Fix swagger docs
2020-06-28 16:25:46 +02:00
author:
$ref: '#/definitions/user.User'
comment:
type: string
Task Relations (#103)
2019-09-25 20:44:41 +02:00
created:
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
id:
Task Relations (#103)
2019-09-25 20:44:41 +02:00
type: integer
Fix swagger docs
2020-06-28 16:25:46 +02:00
updated:
type: string
type: object
models.TaskRelation:
properties:
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this label was created. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Task Relations (#103)
2019-09-25 20:44:41 +02:00
created_by:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/user.User'
Task Relations (#103)
2019-09-25 20:44:41 +02:00
description: The user who created this relation
other_task_id:
description: The ID of the other task, the task which is being related.
type: integer
relation_kind:
description: The kind of the relation.
type: string
task_id:
description: The ID of the "base" task, the task which has a relation to another.
type: integer
type: object
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
models.Team:
properties:
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this relation was created. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
created_by:
$ref: '#/definitions/user.User'
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The user who created this team.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
description:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The team's description.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
id:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The unique, numeric id of this team.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
members:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: An array of all members in this team.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
items:
$ref: '#/definitions/models.TeamUser'
type: array
name:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The name of this team.
maxLength: 250
Saved filters (#655) Fix updating saved filters Fix filter not loadable because of missing param declaration Add fancy special cases for postgres exists in db Add special case for postgrs json Add read one test Add rights tests Fix lint Fixed getting a single saved filter from db Add tests for the usual crud methods Add test stubs and TODOs Add test for converting saved filter ids to list ids and vice versa Add test fixture for saved filters and fix existing tests Fix exposed json variables of filters Fix creating saved filters table for tests Add getting saved filters as pseudo namespace Cleanup Refactor getting all namespaces to use a map for easier handling of pseudo namespaces Add custom erros for saved filters Swagger docs Fix lint Add routes for saved filters Add alias for mage build Add method to get a saved filter from the lists endpoint Add getting tasks from a saved filter Add create, update, delete, read one methods Add rights methods for saved filters Fix docs minLength Add saved filters column Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/655 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-09-26 23:02:17 +02:00
minLength: 1
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
updated:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this relation was last updated. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: object
models.TeamList:
properties:
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this relation was created. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
id:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The unique, numeric id of this list <-> team relation.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
right:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
default: 0
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: The right this team has. 0 = Read only, 1 = Read & Write, 2 = Admin. See the docs for more details.
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
maximum: 2
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
Fix swagger docs
2020-06-28 16:25:46 +02:00
team_id:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The team id.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
updated:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this relation was last updated. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: object
models.TeamMember:
properties:
admin:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Whether or not the member is an admin of the team. See the docs for more about what a team admin can do
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: boolean
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this relation was created. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
id:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The unique, numeric id of this team member relation.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
Use the username instead of a user when adding a user to a team or giving it rights (#76)
2019-05-25 11:47:16 +02:00
username:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: The username of the member. We use this to prevent automated user id entering.
Use the username instead of a user when adding a user to a team or giving it rights (#76)
2019-05-25 11:47:16 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: object
models.TeamNamespace:
properties:
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this relation was created. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
id:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The unique, numeric id of this namespace <-> team relation.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
right:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
default: 0
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: The right this team has. 0 = Read only, 1 = Read & Write, 2 = Admin. See the docs for more details.
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
maximum: 2
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
Fix swagger docs
2020-06-28 16:25:46 +02:00
team_id:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The team id.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
updated:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this relation was last updated. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: object
models.TeamUser:
properties:
admin:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Whether or not the member is an admin of the team. See the docs for more about what a team admin can do
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: boolean
Multiple Reminders (#22)
2018-11-21 16:03:47 +01:00
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this task was created. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
email:
Refactor {List|Namespace}{User|Team} to not expose unneded values via json (#52)
2019-01-14 23:32:56 +01:00
description: The user's email address.
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
maxLength: 250
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
id:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The unique, numeric id of this user.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
Add name field to users
2020-11-21 21:51:55 +01:00
name:
description: The full name of the user.
type: string
Multiple Reminders (#22)
2018-11-21 16:03:47 +01:00
updated:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this task was last updated. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
username:
Refactor {List|Namespace}{User|Team} to not expose unneded values via json (#52)
2019-01-14 23:32:56 +01:00
description: The username of the user. Is always unique.
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
maxLength: 250
Saved filters (#655) Fix updating saved filters Fix filter not loadable because of missing param declaration Add fancy special cases for postgres exists in db Add special case for postgrs json Add read one test Add rights tests Fix lint Fixed getting a single saved filter from db Add tests for the usual crud methods Add test stubs and TODOs Add test for converting saved filter ids to list ids and vice versa Add test fixture for saved filters and fix existing tests Fix exposed json variables of filters Fix creating saved filters table for tests Add getting saved filters as pseudo namespace Cleanup Refactor getting all namespaces to use a map for easier handling of pseudo namespaces Add custom erros for saved filters Swagger docs Fix lint Add routes for saved filters Add alias for mage build Add method to get a saved filter from the lists endpoint Add getting tasks from a saved filter Add create, update, delete, read one methods Add rights methods for saved filters Fix docs minLength Add saved filters column Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/655 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-09-26 23:02:17 +02:00
minLength: 1
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
type: object
models.TeamWithRight:
properties:
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this relation was created. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
created_by:
$ref: '#/definitions/user.User'
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The user who created this team.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
description:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The team's description.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
id:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The unique, numeric id of this team.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
members:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: An array of all members in this team.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
items:
$ref: '#/definitions/models.TeamUser'
type: array
name:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The name of this team.
maxLength: 250
Saved filters (#655) Fix updating saved filters Fix filter not loadable because of missing param declaration Add fancy special cases for postgres exists in db Add special case for postgrs json Add read one test Add rights tests Fix lint Fixed getting a single saved filter from db Add tests for the usual crud methods Add test stubs and TODOs Add test for converting saved filter ids to list ids and vice versa Add test fixture for saved filters and fix existing tests Fix exposed json variables of filters Fix creating saved filters table for tests Add getting saved filters as pseudo namespace Cleanup Refactor getting all namespaces to use a map for easier handling of pseudo namespaces Add custom erros for saved filters Swagger docs Fix lint Add routes for saved filters Add alias for mage build Add method to get a saved filter from the lists endpoint Add getting tasks from a saved filter Add create, update, delete, read one methods Add rights methods for saved filters Fix docs minLength Add saved filters column Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/655 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-09-26 23:02:17 +02:00
minLength: 1
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
right:
type: integer
updated:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this relation was last updated. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: object
Fix swagger docs
2020-06-28 16:25:46 +02:00
models.UserWithRight:
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
properties:
Multiple Reminders (#22)
2018-11-21 16:03:47 +01:00
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this task was created. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
email:
Refactor {List|Namespace}{User|Team} to not expose unneded values via json (#52)
2019-01-14 23:32:56 +01:00
description: The user's email address.
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
maxLength: 250
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
id:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The unique, numeric id of this user.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
Add name field to users
2020-11-21 21:51:55 +01:00
name:
description: The full name of the user.
type: string
Fix swagger docs
2020-06-28 16:25:46 +02:00
right:
Multiple Reminders (#22)
2018-11-21 16:03:47 +01:00
type: integer
Fix swagger docs
2020-06-28 16:25:46 +02:00
updated:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this task was last updated. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
username:
Refactor {List|Namespace}{User|Team} to not expose unneded values via json (#52)
2019-01-14 23:32:56 +01:00
description: The username of the user. Is always unique.
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
maxLength: 250
Saved filters (#655) Fix updating saved filters Fix filter not loadable because of missing param declaration Add fancy special cases for postgres exists in db Add special case for postgrs json Add read one test Add rights tests Fix lint Fixed getting a single saved filter from db Add tests for the usual crud methods Add test stubs and TODOs Add test for converting saved filter ids to list ids and vice versa Add test fixture for saved filters and fix existing tests Fix exposed json variables of filters Fix creating saved filters table for tests Add getting saved filters as pseudo namespace Cleanup Refactor getting all namespaces to use a map for easier handling of pseudo namespaces Add custom erros for saved filters Swagger docs Fix lint Add routes for saved filters Add alias for mage build Add method to get a saved filter from the lists endpoint Add getting tasks from a saved filter Add create, update, delete, read one methods Add rights methods for saved filters Fix docs minLength Add saved filters column Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/655 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-09-26 23:02:17 +02:00
minLength: 1
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
type: object
Authentication with OpenID Connect providers (#713) Add config docs Lint Move provider-related stuff to separate file Refactor getting auth providers Fix tests Fix user tests Fix openid tests Add swagger docs Fix lint Fix lint issues Fix checking if the user already exists Make sure to create a new namespace for new users Docs Add tests for openid Remove unnessecary err check Consistently return nil users if creating a new user failed Move sending confirmation email to separate function Better variable names Move checks to separate functions Refactor creating user into seperate file Fix creating new local users Test creating new users from different issuers Generate a random username right away if no preferred username has been given Add todo Cache openid providers Add getting int clientids Fix migration Move creating tokens to auth package Add getting or creating a third party user Add parsing claims Add retreiving auth tokens Add token callback from openid package Add check for provider key Add routes Start adding openid auth handler Add config for openid auth Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/713 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-11-21 17:38:58 +01:00
openid.Callback:
properties:
code:
type: string
scope:
type: string
type: object
openid.Provider:
properties:
auth_url:
type: string
client_id:
type: string
key:
type: string
name:
type: string
type: object
Fix swagger docs
2020-06-28 16:25:46 +02:00
todoist.Migration:
properties:
code:
type: string
type: object
Add trello migration (#734) Fix tests for background images Generate docs Fix lint Do the swag Add more logging Remove the default bucket if it was empty Add launch.json Make importing backgrounds work Add comment Fix getting task attachments Fix getting trello token Add trello migration routes and status Add support for converting checklists Add test for attachments Add the actual conversion Add Trello conversion test Add migration function stubs Add basic trello migration structure Add trello migration config Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/734 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-12-17 14:44:04 +01:00
trello.Migration:
properties:
code:
type: string
type: object
Fix swagger docs
2020-06-28 16:25:46 +02:00
user.APIUserPassword:
properties:
email:
description: The user's email address
maxLength: 250
type: string
id:
description: The unique, numeric id of this user.
type: integer
password:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: The user's password in clear text. Only used when registering the user.
Fix swagger docs
2020-06-28 16:25:46 +02:00
maxLength: 250
minLength: 8
type: string
username:
description: The username of the username. Is always unique.
maxLength: 250
minLength: 3
type: string
type: object
user.EmailConfirm:
properties:
token:
description: The email confirm token sent via email.
type: string
type: object
user.EmailUpdate:
properties:
new_email:
description: The new email address. Needs to be a valid email address.
type: string
password:
description: The password of the user for confirmation.
type: string
type: object
user.Login:
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
properties:
password:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The password for the user.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
Fix swagger docs
2020-06-28 16:25:46 +02:00
totp_passcode:
description: The totp passcode of a user. Only needs to be provided when enabled.
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
username:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The username used to log in.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
type: object
Fix swagger docs
2020-06-28 16:25:46 +02:00
user.PasswordReset:
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
properties:
Fix swagger docs
2020-06-28 16:25:46 +02:00
new_password:
description: The new password for this user.
type: string
token:
description: The previously issued reset token.
type: string
type: object
user.PasswordTokenRequest:
properties:
email:
maxLength: 250
type: string
type: object
user.TOTP:
properties:
enabled:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: The totp entry will only be enabled after the user verified they have a working totp setup.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: boolean
secret:
type: string
url:
description: The totp url used to be able to enroll the user later
Add the md5-hashed user email to user objects for use with gravatar (#78)
2019-05-31 09:24:59 +02:00
type: string
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: object
user.TOTPPasscode:
properties:
passcode:
type: string
type: object
user.User:
properties:
Multiple Reminders (#22)
2018-11-21 16:03:47 +01:00
created:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this task was created. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
email:
Refactor {List|Namespace}{User|Team} to not expose unneded values via json (#52)
2019-01-14 23:32:56 +01:00
description: The user's email address.
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
maxLength: 250
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
id:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
description: The unique, numeric id of this user.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
Add name field to users
2020-11-21 21:51:55 +01:00
name:
description: The full name of the user.
type: string
Multiple Reminders (#22)
2018-11-21 16:03:47 +01:00
updated:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: A timestamp when this task was last updated. You cannot change this value.
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: string
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
username:
Refactor {List|Namespace}{User|Team} to not expose unneded values via json (#52)
2019-01-14 23:32:56 +01:00
description: The username of the user. Is always unique.
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
maxLength: 250
Saved filters (#655) Fix updating saved filters Fix filter not loadable because of missing param declaration Add fancy special cases for postgres exists in db Add special case for postgrs json Add read one test Add rights tests Fix lint Fixed getting a single saved filter from db Add tests for the usual crud methods Add test stubs and TODOs Add test for converting saved filter ids to list ids and vice versa Add test fixture for saved filters and fix existing tests Fix exposed json variables of filters Fix creating saved filters table for tests Add getting saved filters as pseudo namespace Cleanup Refactor getting all namespaces to use a map for easier handling of pseudo namespaces Add custom erros for saved filters Swagger docs Fix lint Add routes for saved filters Add alias for mage build Add method to get a saved filter from the lists endpoint Add getting tasks from a saved filter Add create, update, delete, read one methods Add rights methods for saved filters Fix docs minLength Add saved filters column Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/655 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-09-26 23:02:17 +02:00
minLength: 1
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: string
type: object
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 19:16:58 +02:00
v1.UserAvatarProvider:
properties:
avatar_provider:
Add name field to users
2020-11-21 21:51:55 +01:00
description: The avatar provider. Valid types are `gravatar` (uses the user email), `upload`, `initials`, `default`.
type: string
type: object
v1.UserName:
properties:
name:
description: The new name of the current user.
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 19:16:58 +02:00
type: string
type: object
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
v1.UserPassword:
properties:
new_password:
type: string
old_password:
type: string
type: object
Authentication with OpenID Connect providers (#713) Add config docs Lint Move provider-related stuff to separate file Refactor getting auth providers Fix tests Fix user tests Fix openid tests Add swagger docs Fix lint Fix lint issues Fix checking if the user already exists Make sure to create a new namespace for new users Docs Add tests for openid Remove unnessecary err check Consistently return nil users if creating a new user failed Move sending confirmation email to separate function Better variable names Move checks to separate functions Refactor creating user into seperate file Fix creating new local users Test creating new users from different issuers Generate a random username right away if no preferred username has been given Add todo Cache openid providers Add getting int clientids Fix migration Move creating tokens to auth package Add getting or creating a third party user Add parsing claims Add retreiving auth tokens Add token callback from openid package Add check for provider key Add routes Start adding openid auth handler Add config for openid auth Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/713 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-11-21 17:38:58 +01:00
v1.authInfo:
properties:
local:
$ref: '#/definitions/v1.localAuthInfo'
openid_connect:
$ref: '#/definitions/v1.openIDAuthInfo'
type: object
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 19:16:58 +02:00
v1.legalInfo:
properties:
imprint_url:
type: string
privacy_policy_url:
type: string
type: object
Authentication with OpenID Connect providers (#713) Add config docs Lint Move provider-related stuff to separate file Refactor getting auth providers Fix tests Fix user tests Fix openid tests Add swagger docs Fix lint Fix lint issues Fix checking if the user already exists Make sure to create a new namespace for new users Docs Add tests for openid Remove unnessecary err check Consistently return nil users if creating a new user failed Move sending confirmation email to separate function Better variable names Move checks to separate functions Refactor creating user into seperate file Fix creating new local users Test creating new users from different issuers Generate a random username right away if no preferred username has been given Add todo Cache openid providers Add getting int clientids Fix migration Move creating tokens to auth package Add getting or creating a third party user Add parsing claims Add retreiving auth tokens Add token callback from openid package Add check for provider key Add routes Start adding openid auth handler Add config for openid auth Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/713 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-11-21 17:38:58 +01:00
v1.localAuthInfo:
properties:
enabled:
type: boolean
type: object
v1.openIDAuthInfo:
properties:
enabled:
type: boolean
providers:
items:
$ref: '#/definitions/openid.Provider'
type: array
redirect_url:
type: string
type: object
/info endpoint (#85)
2019-07-16 00:54:38 +02:00
v1.vikunjaInfos:
properties:
Authentication with OpenID Connect providers (#713) Add config docs Lint Move provider-related stuff to separate file Refactor getting auth providers Fix tests Fix user tests Fix openid tests Add swagger docs Fix lint Fix lint issues Fix checking if the user already exists Make sure to create a new namespace for new users Docs Add tests for openid Remove unnessecary err check Consistently return nil users if creating a new user failed Move sending confirmation email to separate function Better variable names Move checks to separate functions Refactor creating user into seperate file Fix creating new local users Test creating new users from different issuers Generate a random username right away if no preferred username has been given Add todo Cache openid providers Add getting int clientids Fix migration Move creating tokens to auth package Add getting or creating a third party user Add parsing claims Add retreiving auth tokens Add token callback from openid package Add check for provider key Add routes Start adding openid auth handler Add config for openid auth Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/713 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-11-21 17:38:58 +01:00
auth:
$ref: '#/definitions/v1.authInfo'
Migration Improvements (#122) Update swagger docs Update docs Let the wunderlist migrator use the registerRoutes function Add migration status table Add migration status Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/122
2020-01-20 20:48:46 +01:00
available_migrators:
items:
type: string
type: array
Regenerate swagger docs
2020-09-04 13:15:46 +02:00
caldav_enabled:
type: boolean
Fix swagger docs
2020-06-28 16:25:46 +02:00
enabled_background_providers:
items:
type: string
type: array
/info endpoint (#85)
2019-07-16 00:54:38 +02:00
frontend_url:
type: string
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 19:16:58 +02:00
legal:
$ref: '#/definitions/v1.legalInfo'
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
link_sharing_enabled:
type: boolean
Task Attachments (#104)
2019-10-16 22:52:29 +02:00
max_file_size:
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
type: string
/info endpoint (#85)
2019-07-16 00:54:38 +02:00
motd:
type: string
Migration Improvements (#122) Update swagger docs Update docs Let the wunderlist migrator use the registerRoutes function Add migration status table Add migration status Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/122
2020-01-20 20:48:46 +01:00
registration_enabled:
type: boolean
Fix swagger docs
2020-06-28 16:25:46 +02:00
task_attachments_enabled:
type: boolean
totp_enabled:
type: boolean
/info endpoint (#85)
2019-07-16 00:54:38 +02:00
version:
type: string
type: object
Fix swagger docs
2020-06-28 16:25:46 +02:00
web.HTTPError:
properties:
code:
type: integer
message:
type: string
type: object
Migration (#120) Go mod tidy [skip ci] Add modules/migration to docs [skip ci] update date fmt Merge branch 'master' into feature/migration # Conflicts: # pkg/routes/api/v1/info.go Add docs on how to create a migrator Add available migrators to /info endpoint Return a message once everything was migrated successfully Add swagger docs for wunderlist migration Docs for migration [skip ci] Fix due date fixture in migration test Fix staticcheck Fix lint Logging and cleanup Make the migrator work with real data Add routes for migration Fix misspell Add method to store a full vikunja structure into vikunja Add getting all data from wunderlist Add attachment migration from wunderlist Add done and done at to wunderlist migrator Add todo Add wunderlist auth url implementation Fix lint Finish wunderlist migration Added all structs for the wunderlist migratior Fix owner field being null for user shared namespaces (#119) Update copyright year (#118) Add option to disable registration (#117) Added migrator interface Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/120
2020-01-19 17:52:16 +01:00
wunderlist.Migration:
properties:
code:
description: Code is the code used to get a user api token
type: string
Fix swagger docs
2020-06-28 16:25:46 +02:00
type: object
info:
contact:
email: hello@vikunja.io
name: General Vikunja contact
url: http://vikunja.io/en/contact/
description: |-
# Pagination
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.
Return rights when reading a single item (#626) Fix lint Update docs Fix loading all rights (list & namespace) Add tests Update web framework Make tests run again Update all calls to CanRead methods Update task attachment & task comment & task rights to return the max right Update team rights to return the max right Update namespace rights to return the max right Update list rights to return the max right Update link share rights to return the max right Update label rights to return the max right Update web dependency Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/626
2020-08-10 14:11:43 +02:00
# Rights
All endpoints which return a single item (list, task, namespace, 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.
Fix swagger docs
2020-06-28 16:25:46 +02:00
# Authorization
**JWT-Auth:** Main authorization method, used for most of the requests. Needs `Authorization: Bearer <jwt-token>`-header to authenticate successfully.
**BasicAuth:** Only used when requesting tasks via caldav.
<!-- ReDoc-Inject: <security-definitions> -->
license:
name: GPLv3
url: http://code.vikunja.io/api/src/branch/master/LICENSE
title: Vikunja API
paths:
/{username}/avatar:
get:
description: Returns the user avatar as image.
parameters:
- description: The username of the user who's avatar you want to get
in: path
name: username
required: true
type: string
- description: The size of the avatar you want to get
in: query
name: size
type: integer
produces:
- application/octet-stream
responses:
"200":
description: The avatar
schema:
type: ""
"404":
description: The user does not exist.
schema:
$ref: '#/definitions/models.Message'
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
summary: User Avatar
tags:
- user
Authentication with OpenID Connect providers (#713) Add config docs Lint Move provider-related stuff to separate file Refactor getting auth providers Fix tests Fix user tests Fix openid tests Add swagger docs Fix lint Fix lint issues Fix checking if the user already exists Make sure to create a new namespace for new users Docs Add tests for openid Remove unnessecary err check Consistently return nil users if creating a new user failed Move sending confirmation email to separate function Better variable names Move checks to separate functions Refactor creating user into seperate file Fix creating new local users Test creating new users from different issuers Generate a random username right away if no preferred username has been given Add todo Cache openid providers Add getting int clientids Fix migration Move creating tokens to auth package Add getting or creating a third party user Add parsing claims Add retreiving auth tokens Add token callback from openid package Add check for provider key Add routes Start adding openid auth handler Add config for openid auth Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/713 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-11-21 17:38:58 +01:00
/auth/openid/{provider}/callback:
post:
consumes:
- application/json
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.
parameters:
- description: The openid callback
in: body
name: callback
required: true
schema:
$ref: '#/definitions/openid.Callback'
- description: The OpenID Connect provider key as returned by the /info endpoint
in: path
name: provider
required: true
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/auth.Token'
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Authenticate a user with OpenID Connect
tags:
- auth
Fix swagger docs
2020-06-28 16:25:46 +02:00
/backgrounds/unsplash/image/{image}:
get:
description: Get an unsplash image. **Returns json on error.**
parameters:
- description: Unsplash Image ID
in: path
name: thumb
required: true
type: integer
produces:
- application/octet-stream
responses:
"200":
description: The image
schema:
type: ""
"404":
description: The image does not exist.
schema:
$ref: '#/definitions/models.Message'
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Get an unsplash image
tags:
- list
/backgrounds/unsplash/image/{image}/thumb:
get:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Get an unsplash thumbnail image. The thumbnail is cropped to a max width of 200px. **Returns json on error.**
Fix swagger docs
2020-06-28 16:25:46 +02:00
parameters:
- description: Unsplash Image ID
in: path
name: thumb
required: true
type: integer
produces:
- application/octet-stream
responses:
"200":
description: The thumbnail
schema:
type: ""
"404":
description: The image does not exist.
schema:
$ref: '#/definitions/models.Message'
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Get an unsplash thumbnail image
tags:
- list
/backgrounds/unsplash/search:
get:
description: Search for a list background from unsplash
parameters:
- description: Search backgrounds from unsplash with this search term.
in: query
name: s
type: string
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The page number. Used for pagination. If not provided, the first page of results is returned.
Fix swagger docs
2020-06-28 16:25:46 +02:00
in: query
name: p
type: integer
produces:
- application/json
responses:
"200":
description: An array with photos
schema:
items:
$ref: '#/definitions/background.Image'
type: array
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Search for a background from unsplash
tags:
- list
Saved filters (#655) Fix updating saved filters Fix filter not loadable because of missing param declaration Add fancy special cases for postgres exists in db Add special case for postgrs json Add read one test Add rights tests Fix lint Fixed getting a single saved filter from db Add tests for the usual crud methods Add test stubs and TODOs Add test for converting saved filter ids to list ids and vice versa Add test fixture for saved filters and fix existing tests Fix exposed json variables of filters Fix creating saved filters table for tests Add getting saved filters as pseudo namespace Cleanup Refactor getting all namespaces to use a map for easier handling of pseudo namespaces Add custom erros for saved filters Swagger docs Fix lint Add routes for saved filters Add alias for mage build Add method to get a saved filter from the lists endpoint Add getting tasks from a saved filter Add create, update, delete, read one methods Add rights methods for saved filters Fix docs minLength Add saved filters column Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/655 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-09-26 23:02:17 +02:00
/filters:
put:
consumes:
- application/json
description: Creates a new saved filter
produces:
- application/json
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'
security:
- JWTKeyAuth: []
summary: Creates a new saved filter
tags:
- filter
/filters/{id}:
delete:
consumes:
- application/json
description: Removes a saved filter by its ID.
parameters:
- description: Filter ID
in: path
name: id
required: true
type: integer
produces:
- application/json
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'
security:
- JWTKeyAuth: []
summary: Removes a saved filter
tags:
- filter
get:
consumes:
- application/json
description: Returns a saved filter by its ID.
parameters:
- description: Filter ID
in: path
name: id
required: true
type: integer
produces:
- application/json
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'
security:
- JWTKeyAuth: []
summary: Gets one saved filter
tags:
- filter
post:
consumes:
- application/json
description: Updates a saved filter by its ID.
parameters:
- description: Filter ID
in: path
name: id
required: true
type: integer
produces:
- application/json
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'
security:
- JWTKeyAuth: []
summary: Updates a saved filter
tags:
- filter
/info endpoint (#85)
2019-07-16 00:54:38 +02:00
/info:
get:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Returns the version, frontendurl, motd and various settings of Vikunja
/info endpoint (#85)
2019-07-16 00:54:38 +02:00
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/v1.vikunjaInfos'
summary: Info
tags:
- service
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
/labels:
get:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Returns all labels which are either created by the user or associated with a task the user has at least read-access to.
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
parameters:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The page number. Used for pagination. If not provided, the first page of results is returned.
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
in: query
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
name: page
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
in: query
name: per_page
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
type: integer
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
- description: Search labels by label text.
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
in: query
name: s
type: string
produces:
- application/json
responses:
"200":
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
description: The labels
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
schema:
items:
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
$ref: '#/definitions/models.Label'
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
type: array
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
summary: Get all labels a user has access to
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
tags:
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
- labels
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
put:
consumes:
- application/json
description: Creates a new label.
parameters:
- description: The label object
in: body
name: label
required: true
schema:
$ref: '#/definitions/models.Label'
produces:
- application/json
responses:
"200":
description: The created label object.
schema:
$ref: '#/definitions/models.Label'
"400":
description: Invalid label object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
summary: Create a label
tags:
- labels
/labels/{id}:
delete:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Delete an existing label. The user needs to be the creator of the label to be able to do this.
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
parameters:
- description: Label ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The label was successfully deleted.
schema:
$ref: '#/definitions/models.Label'
"403":
description: Not allowed to delete the label.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
"404":
description: Label not found.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
summary: Delete a label
tags:
- labels
get:
consumes:
- application/json
description: Returns one label by its ID.
parameters:
- description: Label ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The label
schema:
$ref: '#/definitions/models.Label'
"403":
description: The user does not have access to the label
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
"404":
description: Label not found
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
summary: Gets one label
tags:
- labels
put:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Update an existing label. The user needs to be the creator of the label to be able to do this.
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
parameters:
- description: Label ID
in: path
name: id
required: true
type: integer
- description: The label object
in: body
name: label
required: true
schema:
$ref: '#/definitions/models.Label'
produces:
- application/json
responses:
"200":
description: The created label object.
schema:
$ref: '#/definitions/models.Label'
"400":
description: Invalid label object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
"403":
description: Not allowed to update the label.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
"404":
description: Label not found.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
summary: Update a label
tags:
- labels
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
/lists:
get:
consumes:
- application/json
description: Returns all lists a user has access to.
parameters:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The page number. Used for pagination. If not provided, the first page of results is returned.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
in: query
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
name: page
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
in: query
name: per_page
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
- description: Search lists by title.
in: query
name: s
type: string
Fix swagger docs
2020-06-28 16:25:46 +02:00
- description: If true, also returns all archived lists.
in: query
name: is_archived
type: boolean
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
produces:
- application/json
responses:
"200":
description: The lists
schema:
items:
$ref: '#/definitions/models.List'
type: array
"403":
description: The user does not have access to the list
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Get all lists a user has access to
tags:
- list
/lists/{id}:
delete:
description: Delets a list
parameters:
- description: List ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The list was successfully deleted.
schema:
$ref: '#/definitions/models.Message'
"400":
description: Invalid list object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"403":
description: The user does not have access to the list
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Deletes a list
tags:
- list
get:
consumes:
- application/json
Add user token renew (#113)
2019-12-07 20:52:04 +01:00
description: Returns a list by its ID.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
parameters:
Add user token renew (#113)
2019-12-07 20:52:04 +01:00
- description: List ID
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
Add user token renew (#113)
2019-12-07 20:52:04 +01:00
description: The list
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
schema:
Add user token renew (#113)
2019-12-07 20:52:04 +01:00
$ref: '#/definitions/models.List'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"403":
Add user token renew (#113)
2019-12-07 20:52:04 +01:00
description: The user does not have access to the list
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Add user token renew (#113)
2019-12-07 20:52:04 +01:00
summary: Gets one list
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
tags:
Add user token renew (#113)
2019-12-07 20:52:04 +01:00
- list
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
post:
consumes:
- application/json
description: Updates a list. This does not include adding a task (see below).
parameters:
- description: List ID
in: path
name: id
required: true
type: integer
- description: The list with updated values you want to update.
in: body
name: list
required: true
schema:
$ref: '#/definitions/models.List'
produces:
- application/json
responses:
"200":
description: The updated list.
schema:
$ref: '#/definitions/models.List'
"400":
description: Invalid list object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"403":
description: The user does not have access to the list
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Updates a list
tags:
- list
put:
consumes:
- application/json
description: Inserts a task into a list.
parameters:
- description: List ID
in: path
name: id
required: true
type: integer
- description: The task object
in: body
name: task
required: true
schema:
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
$ref: '#/definitions/models.Task'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
produces:
- application/json
responses:
"200":
description: The created task object.
schema:
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
$ref: '#/definitions/models.Task'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"400":
description: Invalid task object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"403":
description: The user does not have access to the list
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Create a task
tags:
- task
Fix swagger docs
2020-06-28 16:25:46 +02:00
/lists/{id}/background:
get:
description: Get the list background of a specific list. **Returns json on error.**
parameters:
- description: List ID
in: path
name: id
required: true
type: integer
produces:
- application/octet-stream
responses:
"200":
description: The list background file.
schema:
type: ""
"403":
description: No access to this list.
schema:
$ref: '#/definitions/models.Message'
"404":
description: The list does not exist.
schema:
$ref: '#/definitions/models.Message'
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Get the list background
tags:
- list
/lists/{id}/backgrounds/unsplash:
post:
consumes:
- application/json
description: Sets a photo from unsplash as list background.
parameters:
- description: List ID
in: path
name: id
required: true
type: integer
- description: The image you want to set as background
in: body
name: list
required: true
schema:
$ref: '#/definitions/background.Image'
produces:
- application/json
responses:
"200":
description: The background has been successfully set.
schema:
$ref: '#/definitions/models.List'
"400":
description: Invalid image object provided.
schema:
$ref: '#/definitions/web.HTTPError'
"403":
description: The user does not have access to the list
schema:
$ref: '#/definitions/web.HTTPError'
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Set an unsplash photo as list background
tags:
- list
/lists/{id}/backgrounds/upload:
put:
consumes:
- multipart/form-data
description: Upload a list background.
parameters:
- description: List ID
in: path
name: id
required: true
type: integer
- description: The file as single file.
in: formData
name: background
required: true
type: string
produces:
- application/json
responses:
"200":
description: The background was set successfully.
schema:
$ref: '#/definitions/models.Message'
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 19:16:58 +02:00
"400":
description: File is no image.
schema:
$ref: '#/definitions/models.Message'
Fix swagger docs
2020-06-28 16:25:46 +02:00
"403":
description: File too large.
schema:
$ref: '#/definitions/models.Message'
"404":
description: The list does not exist.
schema:
$ref: '#/definitions/models.Message'
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Upload a list background
tags:
- list
/lists/{id}/buckets:
get:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Returns all kanban buckets with belong to a list including their tasks.
Fix swagger docs
2020-06-28 16:25:46 +02:00
parameters:
- description: List Id
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The buckets with their tasks
schema:
items:
$ref: '#/definitions/models.Bucket'
type: array
"500":
description: Internal server error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Get all kanban buckets of a list
tags:
- task
put:
consumes:
- application/json
description: Creates a new kanban bucket on a list.
parameters:
- description: List Id
in: path
name: id
required: true
type: integer
- description: The bucket object
in: body
name: bucket
required: true
schema:
$ref: '#/definitions/models.Bucket'
produces:
- application/json
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 list does not exist.
schema:
$ref: '#/definitions/web.HTTPError'
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Create a new bucket
tags:
- task
Added http endpoint to list all users on a list (#87)
2019-07-18 18:38:21 +02:00
/lists/{id}/listusers:
get:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Lists all users (without emailadresses). Also possible to search for a specific user.
Added http endpoint to list all users on a list (#87)
2019-07-18 18:38:21 +02:00
parameters:
- description: Search for a user by its name.
in: query
name: s
type: string
- description: List ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: All (found) users.
schema:
items:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/user.User'
Added http endpoint to list all users on a list (#87)
2019-07-18 18:38:21 +02:00
type: array
"400":
description: Something's invalid.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Added http endpoint to list all users on a list (#87)
2019-07-18 18:38:21 +02:00
"401":
description: The user does not have the right to see the list.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Added http endpoint to list all users on a list (#87)
2019-07-18 18:38:21 +02:00
"500":
description: Internal server error.
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Get users
tags:
- list
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
/lists/{id}/teams:
get:
consumes:
- application/json
description: Returns a list with all teams which have access on a given list.
parameters:
- description: List ID
in: path
name: id
required: true
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The page number. Used for pagination. If not provided, the first page of results is returned.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
in: query
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
name: page
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
in: query
name: per_page
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
- description: Search teams by its name.
in: query
name: s
type: string
produces:
- application/json
responses:
"200":
description: The teams with their right.
schema:
items:
$ref: '#/definitions/models.TeamWithRight'
type: array
"403":
description: No right to see the list.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Get teams on a list
tags:
- sharing
put:
consumes:
- application/json
description: Gives a team access to a list.
parameters:
- description: List ID
in: path
name: id
required: true
type: integer
- description: The team you want to add to the list.
in: body
name: list
required: true
schema:
$ref: '#/definitions/models.TeamList'
produces:
- application/json
responses:
"200":
description: The created team<->list relation.
schema:
$ref: '#/definitions/models.TeamList'
"400":
description: Invalid team list object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"403":
description: The user does not have access to the list
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"404":
description: The team does not exist.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Add a team to a list
tags:
- sharing
/lists/{id}/users:
get:
consumes:
- application/json
description: Returns a list with all users which have access on a given list.
parameters:
- description: List ID
in: path
name: id
required: true
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The page number. Used for pagination. If not provided, the first page of results is returned.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
in: query
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
name: page
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
in: query
name: per_page
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
- description: Search users by its name.
in: query
name: s
type: string
produces:
- application/json
responses:
"200":
description: The users with the right they have.
schema:
items:
$ref: '#/definitions/models.UserWithRight'
type: array
"403":
description: No right to see the list.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Get users on a list
tags:
- sharing
put:
consumes:
- application/json
description: Gives a user access to a list.
parameters:
- description: List ID
in: path
name: id
required: true
type: integer
- description: The user you want to add to the list.
in: body
name: list
required: true
schema:
$ref: '#/definitions/models.ListUser'
produces:
- application/json
responses:
"200":
description: The created user<->list relation.
schema:
$ref: '#/definitions/models.ListUser'
"400":
description: Invalid user list object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"403":
description: The user does not have access to the list
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"404":
description: The user does not exist.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Add a user to a list
tags:
- sharing
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
/lists/{list}/shares:
get:
consumes:
- application/json
description: Returns all link shares which exist for a given list
parameters:
- description: List ID
in: path
name: list
required: true
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The page number. Used for pagination. If not provided, the first page of results is returned.
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
in: query
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
name: page
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
in: query
name: per_page
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
type: integer
- description: Search shares by hash.
in: query
name: s
type: string
produces:
- application/json
responses:
"200":
description: The share links
schema:
items:
$ref: '#/definitions/models.LinkSharing'
type: array
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Get all link shares for a list
tags:
- sharing
put:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Share a list via link. The user needs to have write-access to the list to be able do this.
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
parameters:
- description: List ID
in: path
name: list
required: true
type: integer
- description: The new link share object
in: body
name: label
required: true
schema:
$ref: '#/definitions/models.LinkSharing'
produces:
- application/json
responses:
"200":
description: The created link share object.
schema:
$ref: '#/definitions/models.LinkSharing'
"400":
description: Invalid link share object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
"403":
description: Not allowed to add the list share.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
"404":
description: The list does not exist.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Share a list via link
tags:
- sharing
/lists/{list}/shares/{share}:
delete:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Remove a link share. The user needs to have write-access to the list to be able do this.
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
parameters:
- description: List ID
in: path
name: list
required: true
type: integer
- description: Share Link ID
in: path
name: share
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The link was successfully removed.
schema:
$ref: '#/definitions/models.Message'
"403":
description: Not allowed to remove the link.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
"404":
description: Share Link not found.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Remove a link share
tags:
Fix swagger docs
2020-06-28 16:25:46 +02:00
- sharing
get:
consumes:
- application/json
description: Returns one link share by its ID.
parameters:
- description: List ID
in: path
name: list
required: true
type: integer
- description: Share ID
in: path
name: share
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The share links
schema:
$ref: '#/definitions/models.LinkSharing'
"403":
description: No access to the list
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'
security:
- JWTKeyAuth: []
summary: Get one link shares for a list
tags:
- sharing
/lists/{listID}/buckets/{bucketID}:
delete:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
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 list.
Fix swagger docs
2020-06-28 16:25:46 +02:00
parameters:
- description: List Id
in: path
name: listID
required: true
type: integer
- description: Bucket Id
in: path
name: bucketID
required: true
type: integer
produces:
- application/json
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'
security:
- JWTKeyAuth: []
summary: Deletes an existing bucket
tags:
- task
post:
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
consumes:
- application/json
Fix swagger docs
2020-06-28 16:25:46 +02:00
description: Updates an existing kanban bucket.
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
parameters:
Fix swagger docs
2020-06-28 16:25:46 +02:00
- description: List Id
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
in: path
Fix swagger docs
2020-06-28 16:25:46 +02:00
name: listID
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
required: true
type: integer
Fix swagger docs
2020-06-28 16:25:46 +02:00
- description: Bucket Id
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
in: path
Fix swagger docs
2020-06-28 16:25:46 +02:00
name: bucketID
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
required: true
type: integer
Fix swagger docs
2020-06-28 16:25:46 +02:00
- description: The bucket object
in: body
name: bucket
required: true
schema:
$ref: '#/definitions/models.Bucket'
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
produces:
- application/json
responses:
"200":
Fix swagger docs
2020-06-28 16:25:46 +02:00
description: The created bucket object.
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/models.Bucket'
"400":
description: Invalid bucket object provided.
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
"404":
Fix swagger docs
2020-06-28 16:25:46 +02:00
description: The bucket does not exist.
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
Fix swagger docs
2020-06-28 16:25:46 +02:00
summary: Update an existing bucket
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
tags:
Fix swagger docs
2020-06-28 16:25:46 +02:00
- task
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 19:16:58 +02:00
/lists/{listID}/duplicate:
put:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Copies the list, tasks, files, kanban data, assignees, comments, attachments, lables, relations, backgrounds, user/team rights and link shares from one list to a new namespace. The user needs read access in the list and write access in the namespace of the new list.
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 19:16:58 +02:00
parameters:
- description: The list ID to duplicate
in: path
name: listID
required: true
type: integer
- description: The target namespace which should hold the copied list.
in: body
name: list
required: true
schema:
$ref: '#/definitions/models.ListDuplicate'
produces:
- application/json
responses:
"200":
description: The created list.
schema:
$ref: '#/definitions/models.ListDuplicate'
"400":
description: Invalid list duplicate object provided.
schema:
$ref: '#/definitions/web.HTTPError'
"403":
description: The user does not have access to the list or namespace
schema:
$ref: '#/definitions/web.HTTPError'
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Duplicate an existing list
tags:
- list
Endpoint to get tasks on a list (#108)
2019-11-29 23:59:20 +01:00
/lists/{listID}/tasks:
get:
consumes:
- application/json
description: Returns all tasks for the current list.
parameters:
- description: The list ID.
in: path
name: listID
required: true
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The page number. Used for pagination. If not provided, the first page of results is returned.
Endpoint to get tasks on a list (#108)
2019-11-29 23:59:20 +01:00
in: query
name: page
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
Endpoint to get tasks on a list (#108)
2019-11-29 23:59:20 +01:00
in: query
name: per_page
type: integer
- description: Search tasks by task text.
in: query
name: s
type: string
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- 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`, `list_id`, `repeat_after`, `priority`, `start_date`, `end_date`, `hex_color`, `percent_done`, `uid`, `created`, `updated`. Default is `id`.
Sort Order for tasks (#110)
2019-12-07 15:30:51 +01:00
in: query
name: sort_by
type: string
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The ordering parameter. Possible values to order by are `asc` or `desc`. Default is `asc`.
Endpoint to get tasks on a list (#108)
2019-11-29 23:59:20 +01:00
in: query
Sort Order for tasks (#110)
2019-12-07 15:30:51 +01:00
name: order_by
Endpoint to get tasks on a list (#108)
2019-11-29 23:59:20 +01:00
type: string
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The name of the field to filter by. Accepts an array for multiple filters which will be chanied together, all supplied filter must match.
Endpoint to get tasks on a list (#108)
2019-11-29 23:59:20 +01:00
in: query
Fix swagger docs
2020-06-28 16:25:46 +02:00
name: filter_by
type: string
- description: The value to filter for.
Endpoint to get tasks on a list (#108)
2019-11-29 23:59:20 +01:00
in: query
Fix swagger docs
2020-06-28 16:25:46 +02:00
name: filter_value
type: string
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The comparator to use for a filter. Available values are `equals`, `greater`, `greater_equals`, `less` and `less_equals`. Defaults to `equals`
Fix swagger docs
2020-06-28 16:25:46 +02:00
in: query
name: filter_comparator
type: string
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The concatinator to use for filters. Available values are `and` or `or`. Defaults to `or`.
Fix swagger docs
2020-06-28 16:25:46 +02:00
in: query
name: filter_concat
type: string
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- 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`.
Fix swagger docs
2020-06-28 16:25:46 +02:00
in: query
name: filter_include_nulls
type: string
Endpoint to get tasks on a list (#108)
2019-11-29 23:59:20 +01:00
produces:
- application/json
responses:
"200":
description: The tasks
schema:
items:
$ref: '#/definitions/models.Task'
type: array
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
Sort Order for tasks (#110)
2019-12-07 15:30:51 +01:00
summary: Get tasks in a list
Endpoint to get tasks on a list (#108)
2019-11-29 23:59:20 +01:00
tags:
- task
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
/lists/{listID}/teams/{teamID}:
delete:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Delets a team from a list. The team won't have access to the list anymore.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
parameters:
- description: List ID
in: path
name: listID
required: true
type: integer
- description: Team ID
in: path
name: teamID
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The team was successfully deleted.
schema:
$ref: '#/definitions/models.Message'
"403":
description: The user does not have access to the list
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"404":
description: Team or list does not exist.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Delete a team from a list
tags:
- sharing
post:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Update a team <-> list relation. Mostly used to update the right that team has.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
parameters:
- description: List ID
in: path
name: listID
required: true
type: integer
- description: Team ID
in: path
name: teamID
required: true
type: integer
- description: The team you want to update.
in: body
name: list
required: true
schema:
$ref: '#/definitions/models.TeamList'
produces:
- application/json
responses:
"200":
description: The updated team <-> list relation.
schema:
$ref: '#/definitions/models.TeamList'
"403":
description: The user does not have admin-access to the list
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"404":
description: Team or list does not exist.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Update a team <-> list relation
tags:
- sharing
/lists/{listID}/users/{userID}:
delete:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Delets a user from a list. The user won't have access to the list anymore.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
parameters:
- description: List ID
in: path
name: listID
required: true
type: integer
- description: User ID
in: path
name: userID
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The user was successfully removed from the list.
schema:
$ref: '#/definitions/models.Message'
"403":
description: The user does not have access to the list
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"404":
description: user or list does not exist.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Delete a user from a list
tags:
- sharing
post:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Update a user <-> list relation. Mostly used to update the right that user has.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
parameters:
- description: List ID
in: path
name: listID
required: true
type: integer
- description: User ID
in: path
name: userID
required: true
type: integer
- description: The user you want to update.
in: body
name: list
required: true
schema:
$ref: '#/definitions/models.ListUser'
produces:
- application/json
responses:
"200":
description: The updated user <-> list relation.
schema:
$ref: '#/definitions/models.ListUser'
"403":
description: The user does not have admin-access to the list
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"404":
description: User or list does not exist.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Update a user <-> list relation
tags:
- sharing
/login:
post:
consumes:
- application/json
description: Logs a user in. Returns a JWT-Token to authenticate further requests.
parameters:
- description: The login credentials
in: body
name: credentials
required: true
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/user.Login'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
produces:
- application/json
responses:
"200":
description: OK
schema:
Authentication with OpenID Connect providers (#713) Add config docs Lint Move provider-related stuff to separate file Refactor getting auth providers Fix tests Fix user tests Fix openid tests Add swagger docs Fix lint Fix lint issues Fix checking if the user already exists Make sure to create a new namespace for new users Docs Add tests for openid Remove unnessecary err check Consistently return nil users if creating a new user failed Move sending confirmation email to separate function Better variable names Move checks to separate functions Refactor creating user into seperate file Fix creating new local users Test creating new users from different issuers Generate a random username right away if no preferred username has been given Add todo Cache openid providers Add getting int clientids Fix migration Move creating tokens to auth package Add getting or creating a third party user Add parsing claims Add retreiving auth tokens Add token callback from openid package Add check for provider key Add routes Start adding openid auth handler Add config for openid auth Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/713 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-11-21 17:38:58 +01:00
$ref: '#/definitions/auth.Token'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"400":
description: Invalid user password model.
schema:
$ref: '#/definitions/models.Message'
"403":
description: Invalid username or password.
schema:
$ref: '#/definitions/models.Message'
Fix swagger docs
2020-06-28 16:25:46 +02:00
"412":
description: Invalid totp passcode.
schema:
$ref: '#/definitions/models.Message'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Login
tags:
- user
Add Microsoft Todo migration (#737) Add more logs Fix lint Generate docs Add swagger docs Add microsoft todo parsing logic go mod tidy Add basic test structure Add more fields to tasks rename microsoft todo package Add getting microsoft todo data Add structs and helper methods Add microsoft todo config and routes Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/737 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-12-18 12:12:05 +01:00
/migration/microsoft-todo/auth:
get:
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
responses:
"200":
description: The auth url.
schema:
$ref: '#/definitions/handler.AuthURL'
"500":
description: Internal server error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Get the auth url from Microsoft Todo
tags:
- migration
/migration/microsoft-todo/migrate:
post:
consumes:
- application/json
description: Migrates all tasklinsts, tasks, notes and reminders from Microsoft Todo to Vikunja.
parameters:
- description: The auth token previously obtained from the auth url. See the docs for /migration/microsoft-todo/auth.
in: body
name: migrationCode
required: true
schema:
$ref: '#/definitions/microsofttodo.Migration'
produces:
- application/json
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'
security:
- JWTKeyAuth: []
summary: Migrate all lists, tasks etc. from Microsoft Todo
tags:
- migration
/migration/microsoft-todo/status:
get:
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
responses:
"200":
description: The migration status
schema:
$ref: '#/definitions/migration.Status'
"500":
description: Internal server error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Get migration status
tags:
- migration
Fix swagger docs
2020-06-28 16:25:46 +02:00
/migration/todoist/auth:
get:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
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.
Fix swagger docs
2020-06-28 16:25:46 +02:00
produces:
- application/json
responses:
"200":
description: The auth url.
schema:
$ref: '#/definitions/handler.AuthURL'
"500":
description: Internal server error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Get the auth url from todoist
tags:
- migration
/migration/todoist/migrate:
post:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Migrates all projects, tasks, notes, reminders, subtasks and files from todoist to vikunja.
Fix swagger docs
2020-06-28 16:25:46 +02:00
parameters:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The auth code previously obtained from the auth url. See the docs for /migration/todoist/auth.
Fix swagger docs
2020-06-28 16:25:46 +02:00
in: body
name: migrationCode
required: true
schema:
$ref: '#/definitions/todoist.Migration'
produces:
- application/json
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'
security:
- JWTKeyAuth: []
summary: Migrate all lists, tasks etc. from todoist
tags:
- migration
/migration/todoist/status:
get:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
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.
Fix swagger docs
2020-06-28 16:25:46 +02:00
produces:
- application/json
responses:
"200":
description: The migration status
schema:
$ref: '#/definitions/migration.Status'
"500":
description: Internal server error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Get migration status
tags:
Add trello migration (#734) Fix tests for background images Generate docs Fix lint Do the swag Add more logging Remove the default bucket if it was empty Add launch.json Make importing backgrounds work Add comment Fix getting task attachments Fix getting trello token Add trello migration routes and status Add support for converting checklists Add test for attachments Add the actual conversion Add Trello conversion test Add migration function stubs Add basic trello migration structure Add trello migration config Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/734 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-12-17 14:44:04 +01:00
- migration
/migration/trello/auth:
get:
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
responses:
"200":
description: The auth url.
schema:
$ref: '#/definitions/handler.AuthURL'
"500":
description: Internal server error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Get the auth url from trello
tags:
- migration
/migration/trello/migrate:
post:
consumes:
- application/json
description: Migrates all projects, tasks, notes, reminders, subtasks and files from trello to vikunja.
parameters:
- description: The auth token previously obtained from the auth url. See the docs for /migration/trello/auth.
in: body
name: migrationCode
required: true
schema:
$ref: '#/definitions/trello.Migration'
produces:
- application/json
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'
security:
- JWTKeyAuth: []
summary: Migrate all lists, tasks etc. from trello
tags:
- migration
/migration/trello/status:
get:
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
responses:
"200":
description: The migration status
schema:
$ref: '#/definitions/migration.Status'
"500":
description: Internal server error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Get migration status
tags:
Fix swagger docs
2020-06-28 16:25:46 +02:00
- migration
Migration (#120) Go mod tidy [skip ci] Add modules/migration to docs [skip ci] update date fmt Merge branch 'master' into feature/migration # Conflicts: # pkg/routes/api/v1/info.go Add docs on how to create a migrator Add available migrators to /info endpoint Return a message once everything was migrated successfully Add swagger docs for wunderlist migration Docs for migration [skip ci] Fix due date fixture in migration test Fix staticcheck Fix lint Logging and cleanup Make the migrator work with real data Add routes for migration Fix misspell Add method to store a full vikunja structure into vikunja Add getting all data from wunderlist Add attachment migration from wunderlist Add done and done at to wunderlist migrator Add todo Add wunderlist auth url implementation Fix lint Finish wunderlist migration Added all structs for the wunderlist migratior Fix owner field being null for user shared namespaces (#119) Update copyright year (#118) Add option to disable registration (#117) Added migrator interface Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/120
2020-01-19 17:52:16 +01:00
/migration/wunderlist/auth:
get:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Returns the auth url where the user needs to get its auth code. This code can then be used to migrate everything from wunderlist to Vikunja.
Migration (#120) Go mod tidy [skip ci] Add modules/migration to docs [skip ci] update date fmt Merge branch 'master' into feature/migration # Conflicts: # pkg/routes/api/v1/info.go Add docs on how to create a migrator Add available migrators to /info endpoint Return a message once everything was migrated successfully Add swagger docs for wunderlist migration Docs for migration [skip ci] Fix due date fixture in migration test Fix staticcheck Fix lint Logging and cleanup Make the migrator work with real data Add routes for migration Fix misspell Add method to store a full vikunja structure into vikunja Add getting all data from wunderlist Add attachment migration from wunderlist Add done and done at to wunderlist migrator Add todo Add wunderlist auth url implementation Fix lint Finish wunderlist migration Added all structs for the wunderlist migratior Fix owner field being null for user shared namespaces (#119) Update copyright year (#118) Add option to disable registration (#117) Added migrator interface Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/120
2020-01-19 17:52:16 +01:00
produces:
- application/json
responses:
"200":
description: The auth url.
schema:
$ref: '#/definitions/handler.AuthURL'
"500":
description: Internal server error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Get the auth url from wunderlist
tags:
- migration
/migration/wunderlist/migrate:
post:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Migrates all folders, lists, tasks, notes, reminders, subtasks and files from wunderlist to vikunja.
Migration (#120) Go mod tidy [skip ci] Add modules/migration to docs [skip ci] update date fmt Merge branch 'master' into feature/migration # Conflicts: # pkg/routes/api/v1/info.go Add docs on how to create a migrator Add available migrators to /info endpoint Return a message once everything was migrated successfully Add swagger docs for wunderlist migration Docs for migration [skip ci] Fix due date fixture in migration test Fix staticcheck Fix lint Logging and cleanup Make the migrator work with real data Add routes for migration Fix misspell Add method to store a full vikunja structure into vikunja Add getting all data from wunderlist Add attachment migration from wunderlist Add done and done at to wunderlist migrator Add todo Add wunderlist auth url implementation Fix lint Finish wunderlist migration Added all structs for the wunderlist migratior Fix owner field being null for user shared namespaces (#119) Update copyright year (#118) Add option to disable registration (#117) Added migrator interface Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/120
2020-01-19 17:52:16 +01:00
parameters:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The auth code previously obtained from the auth url. See the docs for /migration/wunderlist/auth.
Migration (#120) Go mod tidy [skip ci] Add modules/migration to docs [skip ci] update date fmt Merge branch 'master' into feature/migration # Conflicts: # pkg/routes/api/v1/info.go Add docs on how to create a migrator Add available migrators to /info endpoint Return a message once everything was migrated successfully Add swagger docs for wunderlist migration Docs for migration [skip ci] Fix due date fixture in migration test Fix staticcheck Fix lint Logging and cleanup Make the migrator work with real data Add routes for migration Fix misspell Add method to store a full vikunja structure into vikunja Add getting all data from wunderlist Add attachment migration from wunderlist Add done and done at to wunderlist migrator Add todo Add wunderlist auth url implementation Fix lint Finish wunderlist migration Added all structs for the wunderlist migratior Fix owner field being null for user shared namespaces (#119) Update copyright year (#118) Add option to disable registration (#117) Added migrator interface Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/120
2020-01-19 17:52:16 +01:00
in: body
name: migrationCode
required: true
schema:
$ref: '#/definitions/wunderlist.Migration'
produces:
- application/json
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'
security:
- JWTKeyAuth: []
summary: Migrate all lists, tasks etc. from wunderlist
tags:
- migration
Migration Improvements (#122) Update swagger docs Update docs Let the wunderlist migrator use the registerRoutes function Add migration status table Add migration status Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/122
2020-01-20 20:48:46 +01:00
/migration/wunderlist/status:
get:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
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.
Migration Improvements (#122) Update swagger docs Update docs Let the wunderlist migrator use the registerRoutes function Add migration status table Add migration status Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/122
2020-01-20 20:48:46 +01:00
produces:
- application/json
responses:
"200":
description: The migration status
schema:
$ref: '#/definitions/migration.Status'
"500":
description: Internal server error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Get migration status
tags:
- migration
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
/namespace/{id}:
post:
consumes:
- application/json
description: Updates a namespace.
parameters:
- description: Namespace ID
in: path
name: id
required: true
type: integer
- description: The namespace with updated values you want to update.
in: body
name: namespace
required: true
schema:
$ref: '#/definitions/models.Namespace'
produces:
- application/json
responses:
"200":
description: The updated namespace.
schema:
$ref: '#/definitions/models.Namespace'
"400":
description: Invalid namespace object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"403":
description: The user does not have access to the namespace
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Updates a namespace
tags:
- namespace
/namespaces:
get:
consumes:
- application/json
description: Returns all namespaces a user has access to.
parameters:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The page number. Used for pagination. If not provided, the first page of results is returned.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
in: query
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
name: page
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
in: query
name: per_page
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
- description: Search namespaces by name.
in: query
name: s
type: string
Fix swagger docs
2020-06-28 16:25:46 +02:00
- description: If true, also returns all archived namespaces.
in: query
name: is_archived
type: boolean
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
produces:
- application/json
responses:
"200":
description: The Namespaces.
schema:
items:
$ref: '#/definitions/models.NamespaceWithLists'
type: array
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Get all namespaces a user has access to
tags:
- namespace
put:
consumes:
- application/json
description: Creates a new namespace.
parameters:
- description: The namespace you want to create.
in: body
name: namespace
required: true
schema:
$ref: '#/definitions/models.Namespace'
produces:
- application/json
responses:
"200":
description: The created namespace.
schema:
$ref: '#/definitions/models.Namespace'
"400":
description: Invalid namespace object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"403":
description: The user does not have access to the namespace
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Creates a new namespace
tags:
- namespace
/namespaces/{id}:
delete:
description: Delets a namespace
parameters:
- description: Namespace ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The namespace was successfully deleted.
schema:
$ref: '#/definitions/models.Message'
"400":
description: Invalid namespace object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"403":
description: The user does not have access to the namespace
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Deletes a namespace
tags:
- namespace
get:
consumes:
- application/json
description: Returns a namespace by its ID.
parameters:
- description: Namespace ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The Namespace
schema:
$ref: '#/definitions/models.Namespace'
"403":
description: The user does not have access to that namespace.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Gets one namespace
tags:
- namespace
/namespaces/{id}/lists:
get:
consumes:
- application/json
description: Returns all lists inside of a namespace.
parameters:
- description: Namespace ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The lists.
schema:
items:
$ref: '#/definitions/models.List'
type: array
"403":
description: No access to that namespace.
schema:
$ref: '#/definitions/models.Message'
"404":
description: The namespace does not exist.
schema:
$ref: '#/definitions/models.Message'
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Get all lists in a namespace
tags:
- namespace
/namespaces/{id}/teams:
get:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Returns a namespace with all teams which have access on a given namespace.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
parameters:
- description: Namespace ID
in: path
name: id
required: true
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The page number. Used for pagination. If not provided, the first page of results is returned.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
in: query
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
name: page
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
in: query
name: per_page
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
- description: Search teams by its name.
in: query
name: s
type: string
produces:
- application/json
responses:
"200":
description: The teams with the right they have.
schema:
items:
$ref: '#/definitions/models.TeamWithRight'
type: array
"403":
description: No right to see the namespace.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Get teams on a namespace
tags:
- sharing
put:
consumes:
- application/json
description: Gives a team access to a namespace.
parameters:
- description: Namespace ID
in: path
name: id
required: true
type: integer
- description: The team you want to add to the namespace.
in: body
name: namespace
required: true
schema:
$ref: '#/definitions/models.TeamNamespace'
produces:
- application/json
responses:
"200":
description: The created team<->namespace relation.
schema:
$ref: '#/definitions/models.TeamNamespace'
"400":
description: Invalid team namespace object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"403":
description: The team does not have access to the namespace
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"404":
description: The team does not exist.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Add a team to a namespace
tags:
- sharing
/namespaces/{id}/users:
get:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Returns a namespace with all users which have access on a given namespace.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
parameters:
- description: Namespace ID
in: path
name: id
required: true
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The page number. Used for pagination. If not provided, the first page of results is returned.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
in: query
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
name: page
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
in: query
name: per_page
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
- description: Search users by its name.
in: query
name: s
type: string
produces:
- application/json
responses:
"200":
description: The users with the right they have.
schema:
items:
$ref: '#/definitions/models.UserWithRight'
type: array
"403":
description: No right to see the namespace.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Get users on a namespace
tags:
- sharing
put:
consumes:
- application/json
description: Gives a user access to a namespace.
parameters:
- description: Namespace ID
in: path
name: id
required: true
type: integer
- description: The user you want to add to the namespace.
in: body
name: namespace
required: true
schema:
$ref: '#/definitions/models.NamespaceUser'
produces:
- application/json
responses:
"200":
description: The created user<->namespace relation.
schema:
$ref: '#/definitions/models.NamespaceUser'
"400":
description: Invalid user namespace object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"403":
description: The user does not have access to the namespace
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"404":
description: The user does not exist.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Add a user to a namespace
tags:
- sharing
/namespaces/{namespaceID}/lists:
put:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Creates a new list in a given namespace. The user needs write-access to the namespace.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
parameters:
- description: Namespace ID
in: path
name: namespaceID
required: true
type: integer
- description: The list you want to create.
in: body
name: list
required: true
schema:
$ref: '#/definitions/models.List'
produces:
- application/json
responses:
"200":
description: The created list.
schema:
$ref: '#/definitions/models.List'
"400":
description: Invalid list object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"403":
description: The user does not have access to the list
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Creates a new list
tags:
- list
/namespaces/{namespaceID}/teams/{teamID}:
delete:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Delets a team from a namespace. The team won't have access to the namespace anymore.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
parameters:
- description: Namespace ID
in: path
name: namespaceID
required: true
type: integer
- description: team ID
in: path
name: teamID
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The team was successfully deleted.
schema:
$ref: '#/definitions/models.Message'
"403":
description: The team does not have access to the namespace
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"404":
description: team or namespace does not exist.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Delete a team from a namespace
tags:
- sharing
post:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Update a team <-> namespace relation. Mostly used to update the right that team has.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
parameters:
- description: Namespace ID
in: path
name: namespaceID
required: true
type: integer
- description: Team ID
in: path
name: teamID
required: true
type: integer
- description: The team you want to update.
in: body
name: namespace
required: true
schema:
$ref: '#/definitions/models.TeamNamespace'
produces:
- application/json
responses:
"200":
description: The updated team <-> namespace relation.
schema:
$ref: '#/definitions/models.TeamNamespace'
"403":
description: The team does not have admin-access to the namespace
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"404":
description: Team or namespace does not exist.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Update a team <-> namespace relation
tags:
- sharing
/namespaces/{namespaceID}/users/{userID}:
delete:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Delets a user from a namespace. The user won't have access to the namespace anymore.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
parameters:
- description: Namespace ID
in: path
name: namespaceID
required: true
type: integer
- description: user ID
in: path
name: userID
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The user was successfully deleted.
schema:
$ref: '#/definitions/models.Message'
"403":
description: The user does not have access to the namespace
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"404":
description: user or namespace does not exist.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Delete a user from a namespace
tags:
- sharing
post:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Update a user <-> namespace relation. Mostly used to update the right that user has.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
parameters:
- description: Namespace ID
in: path
name: namespaceID
required: true
type: integer
- description: User ID
in: path
name: userID
required: true
type: integer
- description: The user you want to update.
in: body
name: namespace
required: true
schema:
$ref: '#/definitions/models.NamespaceUser'
produces:
- application/json
responses:
"200":
description: The updated user <-> namespace relation.
schema:
$ref: '#/definitions/models.NamespaceUser'
"403":
description: The user does not have admin-access to the namespace
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"404":
description: User or namespace does not exist.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Update a user <-> namespace relation
tags:
- sharing
/register:
post:
consumes:
- application/json
description: Creates a new user account.
parameters:
- description: The user credentials
in: body
name: credentials
required: true
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/user.APIUserPassword'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
produces:
- application/json
responses:
"200":
description: OK
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/user.User'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"400":
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: No or invalid user register object provided / User already exists.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
summary: Register
tags:
- user
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
/shares/{share}/auth:
post:
consumes:
- application/json
description: Get a jwt auth token for a shared list from a share hash.
parameters:
- description: The share hash
in: path
name: share
required: true
type: string
produces:
- application/json
responses:
"200":
description: The valid jwt auth token.
schema:
Authentication with OpenID Connect providers (#713) Add config docs Lint Move provider-related stuff to separate file Refactor getting auth providers Fix tests Fix user tests Fix openid tests Add swagger docs Fix lint Fix lint issues Fix checking if the user already exists Make sure to create a new namespace for new users Docs Add tests for openid Remove unnessecary err check Consistently return nil users if creating a new user failed Move sending confirmation email to separate function Better variable names Move checks to separate functions Refactor creating user into seperate file Fix creating new local users Test creating new users from different issuers Generate a random username right away if no preferred username has been given Add todo Cache openid providers Add getting int clientids Fix migration Move creating tokens to auth package Add getting or creating a third party user Add parsing claims Add retreiving auth tokens Add token callback from openid package Add check for provider key Add routes Start adding openid auth handler Add config for openid auth Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/713 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-11-21 17:38:58 +01:00
$ref: '#/definitions/auth.Token'
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
"400":
description: Invalid link share object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
summary: Get an auth token for a share
tags:
- sharing
Add task identifier (#115)
2019-12-07 23:28:45 +01:00
/tasks/{ID}:
get:
consumes:
- application/json
description: Returns one task by its ID
parameters:
- description: The task ID
in: path
name: ID
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The task
schema:
$ref: '#/definitions/models.Task'
"404":
description: Task not found
schema:
$ref: '#/definitions/models.Message'
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Get one task
tags:
- task
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
/tasks/{id}:
delete:
description: Deletes a task from a list. This does not mean "mark it done".
parameters:
- description: Task ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The created task object.
schema:
$ref: '#/definitions/models.Message'
"400":
description: Invalid task ID provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"403":
description: The user does not have access to the list
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Delete a task
tags:
- task
post:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02: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.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
parameters:
- description: Task ID
in: path
name: id
required: true
type: integer
- description: The task object
in: body
name: task
required: true
schema:
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
$ref: '#/definitions/models.Task'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
produces:
- application/json
responses:
"200":
description: The updated task object.
schema:
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
$ref: '#/definitions/models.Task'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"400":
description: Invalid task object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"403":
description: The user does not have access to the task (aka its list)
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Update a task
tags:
- task
Task Attachments (#104)
2019-10-16 22:52:29 +02:00
/tasks/{id}/attachments:
get:
consumes:
- application/json
description: Get all task attachments for one task.
parameters:
- description: Task ID
in: path
name: id
required: true
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The page number. Used for pagination. If not provided, the first page of results is returned.
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
in: query
name: page
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
in: query
name: per_page
type: integer
Task Attachments (#104)
2019-10-16 22:52:29 +02:00
produces:
- application/json
responses:
"200":
description: All attachments for this task
schema:
items:
$ref: '#/definitions/models.TaskAttachment'
type: array
"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'
security:
- JWTKeyAuth: []
summary: Get all attachments for one task.
tags:
- task
put:
consumes:
- multipart/form-data
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Upload a task attachment. You can pass multiple files with the files form param.
Task Attachments (#104)
2019-10-16 22:52:29 +02:00
parameters:
- description: Task ID
in: path
name: id
required: true
type: integer
- description: The file, as multipart form file. You can pass multiple.
in: formData
name: files
required: true
type: string
produces:
- application/json
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'
security:
- JWTKeyAuth: []
summary: Upload a task attachment
tags:
- task
/tasks/{id}/attachments/{attachmentID}:
delete:
consumes:
- application/json
description: Delete an attachment.
parameters:
- description: Task ID
in: path
name: id
required: true
type: integer
- description: Attachment ID
in: path
name: attachmentID
required: true
type: integer
produces:
- application/json
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'
security:
- JWTKeyAuth: []
summary: Delete an attachment
tags:
- task
get:
description: Get one attachment for download. **Returns json on error.**
parameters:
- description: Task ID
in: path
name: id
required: true
type: integer
- description: Attachment ID
in: path
name: attachmentID
required: true
type: integer
produces:
- application/octet-stream
responses:
"200":
description: The attachment file.
schema:
type: ""
"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'
security:
- JWTKeyAuth: []
summary: Get one attachment.
tags:
- task
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
/tasks/{task}/labels:
get:
consumes:
- application/json
description: Returns all labels which are assicociated with a given task.
parameters:
- description: Task ID
in: path
name: task
required: true
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The page number. Used for pagination. If not provided, the first page of results is returned.
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
in: query
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
name: page
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
in: query
name: per_page
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
type: integer
- description: Search labels by label text.
in: query
name: s
type: string
produces:
- application/json
responses:
"200":
description: The labels
schema:
items:
$ref: '#/definitions/models.Label'
type: array
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
summary: Get all labels on a task
tags:
- labels
put:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Add a label to a task. The user needs to have write-access to the list to be able do this.
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
parameters:
- description: Task ID
in: path
name: task
required: true
type: integer
- description: The label object
in: body
name: label
required: true
schema:
Fixed swagger docs for task labels
2019-03-21 07:40:56 +01:00
$ref: '#/definitions/models.LabelTask'
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
produces:
- application/json
responses:
"200":
description: The created label relation object.
schema:
Fixed swagger docs for task labels
2019-03-21 07:40:56 +01:00
$ref: '#/definitions/models.LabelTask'
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
"400":
description: Invalid label object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
"403":
description: Not allowed to add the label.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
"404":
description: The label does not exist.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
summary: Add a label to a task
tags:
- labels
/tasks/{task}/labels/{label}:
delete:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Remove a label from a task. The user needs to have write-access to the list to be able do this.
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
parameters:
- description: Task ID
in: path
name: task
required: true
type: integer
- description: Label ID
in: path
name: label
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The label was successfully removed.
schema:
Fixed swagger docs for task labels
2019-03-21 07:40:56 +01:00
$ref: '#/definitions/models.Message'
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
"403":
description: Not allowed to remove the label.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
"404":
description: Label not found.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Add labels to tasks (#45)
2018-12-31 02:18:41 +01:00
summary: Remove a label from a task
tags:
- labels
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
/tasks/{taskID}/assignees:
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
get:
consumes:
- application/json
description: Returns an array with all assignees for this task.
parameters:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The page number. Used for pagination. If not provided, the first page of results is returned.
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
in: query
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
name: page
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
in: query
name: per_page
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
type: integer
- description: Search assignees by their username.
in: query
name: s
type: string
- description: Task ID
in: path
name: taskID
required: true
type: integer
produces:
- application/json
responses:
"200":
Fix swagger docs
2020-06-28 16:25:46 +02:00
description: The assignees
schema:
items:
$ref: '#/definitions/user.User'
type: array
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Get all assignees for a task
tags:
- assignees
put:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Adds a new assignee to a task. The assignee needs to have access to the list, the doer must be able to edit this task.
Fix swagger docs
2020-06-28 16:25:46 +02:00
parameters:
- description: The assingee object
in: body
name: assignee
required: true
schema:
$ref: '#/definitions/models.TaskAssginee'
- description: Task ID
in: path
name: taskID
required: true
type: integer
produces:
- application/json
responses:
"200":
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'
security:
- JWTKeyAuth: []
summary: Add a new assignee to a task
tags:
- assignees
/tasks/{taskID}/assignees/{userID}:
delete:
consumes:
- application/json
description: Un-assign a user from a task.
parameters:
- description: Task ID
in: path
name: taskID
required: true
type: integer
- description: Assignee user ID
in: path
name: userID
required: true
type: integer
produces:
- application/json
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'
security:
- JWTKeyAuth: []
summary: Delete an assignee
tags:
- assignees
/tasks/{taskID}/assignees/bulk:
post:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Adds multiple new assignees to a task. The assignee needs to have access to the list, the doer must be able to edit this task. Every user not in the list will be unassigned from the task, pass an empty array to unassign everyone.
Fix swagger docs
2020-06-28 16:25:46 +02:00
parameters:
- description: The array of assignees
in: body
name: assignee
required: true
schema:
$ref: '#/definitions/models.BulkAssignees'
- description: Task ID
in: path
name: taskID
required: true
type: integer
produces:
- application/json
responses:
"200":
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'
security:
- JWTKeyAuth: []
summary: Add multiple new assignees to a task
tags:
- assignees
/tasks/{taskID}/comments:
get:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Get all task comments. The user doing this need to have at least read access to the task.
Fix swagger docs
2020-06-28 16:25:46 +02:00
parameters:
- description: Task ID
in: path
name: taskID
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The array with all task comments
schema:
items:
$ref: '#/definitions/models.TaskComment'
type: array
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Get all task comments
tags:
- task
put:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
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.
Fix swagger docs
2020-06-28 16:25:46 +02:00
parameters:
- description: The task comment object
in: body
name: relation
required: true
schema:
$ref: '#/definitions/models.TaskComment'
- description: Task ID
in: path
name: taskID
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The created task comment object.
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/models.TaskComment'
"400":
description: Invalid task comment object provided.
schema:
$ref: '#/definitions/web.HTTPError'
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
Fix swagger docs
2020-06-28 16:25:46 +02:00
summary: Create a new task comment
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
tags:
Fix swagger docs
2020-06-28 16:25:46 +02:00
- task
/tasks/{taskID}/comments/{commentID}:
delete:
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Remove a task comment. The user doing this need to have at least write access to the task this comment belongs to.
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
parameters:
- description: Task ID
in: path
name: taskID
required: true
type: integer
Fix swagger docs
2020-06-28 16:25:46 +02:00
- description: Comment ID
in: path
name: commentID
required: true
type: integer
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
produces:
- application/json
responses:
"200":
Fix swagger docs
2020-06-28 16:25:46 +02:00
description: The task comment was successfully deleted.
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/models.Message'
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
"400":
Fix swagger docs
2020-06-28 16:25:46 +02:00
description: Invalid task comment object provided.
schema:
$ref: '#/definitions/web.HTTPError'
"404":
description: The task comment was not found.
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
Fix swagger docs
2020-06-28 16:25:46 +02:00
summary: Remove a task comment
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
tags:
Fix swagger docs
2020-06-28 16:25:46 +02:00
- task
get:
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Remove a task comment. The user doing this need to have at least read access to the task this comment belongs to.
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
parameters:
- description: Task ID
in: path
name: taskID
required: true
type: integer
Fix swagger docs
2020-06-28 16:25:46 +02:00
- description: Comment ID
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
in: path
Fix swagger docs
2020-06-28 16:25:46 +02:00
name: commentID
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
required: true
type: integer
produces:
- application/json
responses:
"200":
Fix swagger docs
2020-06-28 16:25:46 +02:00
description: The task comment object.
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/models.TaskComment'
"400":
description: Invalid task comment object provided.
schema:
$ref: '#/definitions/web.HTTPError'
"404":
description: The task comment was not found.
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
Fix swagger docs
2020-06-28 16:25:46 +02:00
summary: Remove a task comment
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
tags:
Fix swagger docs
2020-06-28 16:25:46 +02:00
- task
Improve label handling (#48)
2019-01-10 00:08:12 +01:00
post:
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Update an existing task comment. The user doing this need to have at least write access to the task this comment belongs to.
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
parameters:
- description: Task ID
in: path
name: taskID
required: true
type: integer
Fix swagger docs
2020-06-28 16:25:46 +02:00
- description: Comment ID
in: path
name: commentID
required: true
type: integer
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
produces:
- application/json
responses:
"200":
Fix swagger docs
2020-06-28 16:25:46 +02:00
description: The updated task comment object.
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/models.TaskComment'
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
"400":
Fix swagger docs
2020-06-28 16:25:46 +02:00
description: Invalid task comment object provided.
schema:
$ref: '#/definitions/web.HTTPError'
"404":
description: The task comment was not found.
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
Fix swagger docs
2020-06-28 16:25:46 +02:00
summary: Update an existing task comment
Assignees optimizations (#47)
2019-01-08 20:13:07 +01:00
tags:
Fix swagger docs
2020-06-28 16:25:46 +02:00
- task
Improve label handling (#48)
2019-01-10 00:08:12 +01:00
/tasks/{taskID}/labels/bulk:
post:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
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.
Improve label handling (#48)
2019-01-10 00:08:12 +01:00
parameters:
- description: The array of labels
in: body
name: label
required: true
schema:
$ref: '#/definitions/models.LabelTaskBulk'
- description: Task ID
in: path
name: taskID
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The updated labels object.
schema:
$ref: '#/definitions/models.LabelTaskBulk'
"400":
description: Invalid label object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Improve label handling (#48)
2019-01-10 00:08:12 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
Fixed swagger docs for bulk label tasks
2019-03-21 18:42:21 +01:00
summary: Update all labels on a task.
Improve label handling (#48)
2019-01-10 00:08:12 +01:00
tags:
- labels
Task Relations (#103)
2019-09-25 20:44:41 +02:00
/tasks/{taskID}/relations:
delete:
consumes:
- application/json
parameters:
- description: The relation object
in: body
name: relation
required: true
schema:
$ref: '#/definitions/models.TaskRelation'
- description: Task ID
in: path
name: taskID
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The task relation was successfully deleted.
schema:
$ref: '#/definitions/models.Message'
"400":
description: Invalid task relation object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Task Relations (#103)
2019-09-25 20:44:41 +02:00
"404":
description: The task relation was not found.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Task Relations (#103)
2019-09-25 20:44:41 +02:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Remove a task relation
tags:
- task
put:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
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 list. Take a look at the docs for available task relation kinds.
Task Relations (#103)
2019-09-25 20:44:41 +02:00
parameters:
- description: The relation object
in: body
name: relation
required: true
schema:
$ref: '#/definitions/models.TaskRelation'
- description: Task ID
in: path
name: taskID
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The created task relation object.
schema:
$ref: '#/definitions/models.TaskRelation'
"400":
description: Invalid task relation object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Task Relations (#103)
2019-09-25 20:44:41 +02:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Create a new relation between two tasks
tags:
- task
Updated swagger docs
2018-12-25 21:45:26 +01:00
/tasks/all:
Priorites for tasks (#31)
2018-12-02 01:49:30 +01:00
get:
consumes:
- application/json
Add task identifier (#115)
2019-12-07 23:28:45 +01:00
description: Returns all tasks on any list the user has access to.
Priorites for tasks (#31)
2018-12-02 01:49:30 +01:00
parameters:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The page number. Used for pagination. If not provided, the first page of results is returned.
Add task identifier (#115)
2019-12-07 23:28:45 +01:00
in: query
name: page
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
Add task identifier (#115)
2019-12-07 23:28:45 +01:00
in: query
name: per_page
type: integer
- description: Search tasks by task text.
in: query
name: s
type: string
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- 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`, `text`, `description`, `done`, `done_at`, `due_date`, `created_by_id`, `list_id`, `repeat_after`, `priority`, `start_date`, `end_date`, `hex_color`, `percent_done`, `uid`, `created`, `updated`. Default is `id`.
Add task identifier (#115)
2019-12-07 23:28:45 +01:00
in: query
Fix swagger docs
2020-06-28 16:25:46 +02:00
name: sort_by
Add task identifier (#115)
2019-12-07 23:28:45 +01:00
type: string
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The ordering parameter. Possible values to order by are `asc` or `desc`. Default is `asc`.
Add task identifier (#115)
2019-12-07 23:28:45 +01:00
in: query
Fix swagger docs
2020-06-28 16:25:46 +02:00
name: order_by
type: string
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The name of the field to filter by. Accepts an array for multiple filters which will be chanied together, all supplied filter must match.
Add task identifier (#115)
2019-12-07 23:28:45 +01:00
in: query
Fix swagger docs
2020-06-28 16:25:46 +02:00
name: filter_by
type: string
- description: The value to filter for.
in: query
name: filter_value
type: string
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The comparator to use for a filter. Available values are `equals`, `greater`, `greater_equals`, `less` and `less_equals`. Defaults to `equals`
Fix swagger docs
2020-06-28 16:25:46 +02:00
in: query
name: filter_comparator
type: string
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The concatinator to use for filters. Available values are `and` or `or`. Defaults to `or`.
Fix swagger docs
2020-06-28 16:25:46 +02:00
in: query
name: filter_concat
type: string
Updated swagger docs
2018-12-25 21:45:26 +01:00
produces:
- application/json
responses:
"200":
Add task identifier (#115)
2019-12-07 23:28:45 +01:00
description: The tasks
Add endpoint to get a single task (#106)
2019-11-02 21:33:18 +01:00
schema:
Add task identifier (#115)
2019-12-07 23:28:45 +01:00
items:
$ref: '#/definitions/models.Task'
type: array
Updated swagger docs
2018-12-25 21:45:26 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Add task identifier (#115)
2019-12-07 23:28:45 +01:00
summary: Get tasks
Updated swagger docs
2018-12-25 21:45:26 +01:00
tags:
- task
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
/tasks/bulk:
post:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
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.'
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
parameters:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The task object. Looks like a normal task, the only difference is it uses an array of list_ids to update.
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
in: body
name: task
required: true
schema:
$ref: '#/definitions/models.BulkTask'
produces:
- application/json
responses:
"200":
description: The updated task object.
schema:
Sharing of lists via public links (#94)
2019-08-31 22:56:41 +02:00
$ref: '#/definitions/models.Task'
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
"400":
description: Invalid task object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
"403":
description: The user does not have access to the task (aka its list)
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Add bulk edit for tasks (#42)
2018-12-28 22:49:46 +01:00
summary: Update a bunch of tasks at once
tags:
- task
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
/teams:
get:
consumes:
- application/json
description: Returns all teams the current user is part of.
parameters:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The page number. Used for pagination. If not provided, the first page of results is returned.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
in: query
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
name: page
type: integer
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
- description: The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
Improve pagination (#105)
2019-10-23 23:11:40 +02:00
in: query
name: per_page
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: integer
- description: Search teams by its name.
in: query
name: s
type: string
produces:
- application/json
responses:
"200":
description: The teams.
schema:
items:
$ref: '#/definitions/models.Team'
type: array
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Get teams
tags:
- team
put:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Creates a new team in a given namespace. The user needs write-access to the namespace.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
parameters:
- description: The team you want to create.
in: body
name: team
required: true
schema:
$ref: '#/definitions/models.Team'
produces:
- application/json
responses:
"200":
description: The created team.
schema:
$ref: '#/definitions/models.Team'
"400":
description: Invalid team object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Creates a new team
tags:
- team
/teams/{id}:
delete:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Delets a team. This will also remove the access for all users in that team.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
parameters:
- description: Team ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The team was successfully deleted.
schema:
$ref: '#/definitions/models.Message'
"400":
description: Invalid team object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Deletes a team
tags:
- team
Fix swagger docs
2020-06-28 16:25:46 +02:00
get:
consumes:
- application/json
description: Returns a team by its ID.
parameters:
- description: Team ID
in: path
name: id
required: true
type: integer
produces:
- application/json
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'
security:
- JWTKeyAuth: []
summary: Gets one team
tags:
- team
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
post:
consumes:
- application/json
description: Updates a team.
parameters:
- description: Team ID
in: path
name: id
required: true
type: integer
- description: The team with updated values you want to update.
in: body
name: team
required: true
schema:
$ref: '#/definitions/models.Team'
produces:
- application/json
responses:
"200":
description: The updated team.
schema:
$ref: '#/definitions/models.Team'
"400":
description: Invalid team object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Updates a team
tags:
- team
/teams/{id}/members:
put:
consumes:
- application/json
description: Add a user to a team.
parameters:
- description: Team ID
in: path
name: id
required: true
type: integer
- description: The user to be added to a team.
in: body
name: team
required: true
schema:
$ref: '#/definitions/models.TeamMember'
produces:
- application/json
responses:
"200":
description: The newly created member object
schema:
$ref: '#/definitions/models.TeamMember'
"400":
description: Invalid member object provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"403":
description: The user does not have access to the team
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Add a user to a team
tags:
- team
/teams/{id}/members/{userID}:
delete:
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Remove a user from a team. This will also revoke any access this user might have via that team.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
parameters:
- description: Team ID
in: path
name: id
required: true
type: integer
- description: User ID
in: path
name: userID
required: true
type: integer
produces:
- application/json
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'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Remove a user from a team
tags:
- team
Add update route to toggle team member admin status
2020-08-05 17:21:17 +02:00
/teams/{id}/members/{userID}/admin:
post:
description: If a user is team admin, this will make them member and vise-versa.
parameters:
- description: Team ID
in: path
name: id
required: true
type: integer
- description: User ID
in: path
name: userID
required: true
type: integer
produces:
- application/json
responses:
"200":
description: The member right was successfully changed.
schema:
$ref: '#/definitions/models.Message'
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Toggle a team member's admin status
tags:
- team
Add testing endpoint to reset db tables (#716) Fix lint Better error messages Add docs Add testing endpoint to reset db Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/716 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-11-29 00:08:30 +01:00
/test/{table}:
patch:
consumes:
- application/json
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: <token>` secret when making requests to this endpoint. See docs for more details.'
parameters:
- description: The table to reset
in: path
name: table
required: true
type: string
produces:
- application/json
responses:
"201":
description: Everything has been imported successfully.
schema:
items:
$ref: '#/definitions/user.User'
type: array
"500":
description: Internal server error.
schema:
$ref: '#/definitions/models.Message'
summary: Reset the db to a defined state
tags:
- testing
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
/user:
get:
consumes:
- application/json
description: Returns the current user object.
produces:
- application/json
responses:
"200":
description: OK
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/user.User'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"404":
description: User does not exist.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal server error.
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Get user information
tags:
- user
/user/confirm:
post:
consumes:
- application/json
description: Confirms the email of a newly registered user.
parameters:
- description: The token.
in: body
name: credentials
required: true
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/user.EmailConfirm'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.Message'
"412":
description: Bad token provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
summary: Confirm the email of a new user
tags:
- user
/user/password:
post:
consumes:
- application/json
description: Lets the current user change its password.
parameters:
- description: The current and new password.
in: body
name: userPassword
required: true
schema:
$ref: '#/definitions/v1.UserPassword'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.Message'
"400":
description: Something's invalid.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"404":
description: User does not exist.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal server error.
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Change password
tags:
- user
/user/password/reset:
post:
consumes:
- application/json
description: Resets a user email with a previously reset token.
parameters:
- description: The token with the new password.
in: body
name: credentials
required: true
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/user.PasswordReset'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.Message'
"400":
description: Bad token provided.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
summary: Resets a password
tags:
- user
/user/password/token:
post:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Requests a token to reset a users password. The token is sent via email.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
parameters:
- description: The username of the user to request a token for.
in: body
name: credentials
required: true
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/user.PasswordTokenRequest'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.Message'
"404":
description: The user does not exist.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
summary: Request password reset token
tags:
- user
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 19:16:58 +02:00
/user/settings/avatar:
get:
consumes:
- application/json
description: Returns the current user's avatar setting.
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/v1.UserAvatarProvider'
"400":
description: Something's invalid.
schema:
$ref: '#/definitions/web.HTTPError'
"500":
description: Internal server error.
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Return user avatar setting
tags:
- user
post:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Changes the user avatar. Valid types are gravatar (uses the user email), upload, initials, default.
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 19:16:58 +02:00
parameters:
- description: The user's avatar setting
in: body
name: avatar
required: true
schema:
$ref: '#/definitions/v1.UserAvatarProvider'
produces:
- application/json
responses:
"200":
description: OK
schema:
Add name field to users
2020-11-21 21:51:55 +01:00
$ref: '#/definitions/models.Message'
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 19:16:58 +02:00
"400":
description: Something's invalid.
schema:
$ref: '#/definitions/web.HTTPError'
"500":
description: Internal server error.
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Set the user's avatar
tags:
- user
/user/settings/avatar/upload:
put:
consumes:
- multipart/form-data
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Upload a user avatar. This will also set the user's avatar provider to "upload"
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 19:16:58 +02:00
parameters:
- description: The avatar as single file.
in: formData
name: avatar
required: true
type: string
produces:
- application/json
responses:
"200":
description: The avatar 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'
"500":
description: Internal error
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Upload a user avatar
tags:
- user
Fix swagger docs
2020-06-28 16:25:46 +02:00
/user/settings/email:
post:
consumes:
- application/json
description: Lets the current user change their email address.
parameters:
- description: The new email address and current password.
in: body
name: userEmailUpdate
required: true
schema:
$ref: '#/definitions/user.EmailUpdate'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.Message'
"400":
description: Something's invalid.
schema:
$ref: '#/definitions/web.HTTPError'
"404":
description: User does not exist.
schema:
$ref: '#/definitions/web.HTTPError'
"500":
description: Internal server error.
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Update email address
tags:
- user
Add name field to users
2020-11-21 21:51:55 +01:00
/user/settings/name:
post:
consumes:
- application/json
description: Changes the current user's name. It is also possible to reset the name.
parameters:
- description: The updated user name
in: body
name: avatar
required: true
schema:
$ref: '#/definitions/v1.UserName'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.Message'
"400":
description: Something's invalid.
schema:
$ref: '#/definitions/web.HTTPError'
"500":
description: Internal server error.
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Change the current user's name
tags:
- user
Fix swagger docs
2020-06-28 16:25:46 +02:00
/user/settings/totp:
get:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Returns the current user totp setting or an error if it is not enabled.
Fix swagger docs
2020-06-28 16:25:46 +02:00
produces:
- application/json
responses:
"200":
description: The totp settings.
schema:
$ref: '#/definitions/user.TOTP'
"500":
description: Internal server error.
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Totp setting for the current user
tags:
- user
/user/settings/totp/disable:
post:
consumes:
- application/json
description: Disables any totp settings for the current user.
parameters:
- description: The current user's password (only password is enough).
in: body
name: totp
required: true
schema:
$ref: '#/definitions/user.Login'
produces:
- application/json
responses:
"200":
description: Successfully disabled
schema:
$ref: '#/definitions/models.Message'
"400":
description: Something's invalid.
schema:
$ref: '#/definitions/web.HTTPError'
"404":
description: User does not exist.
schema:
$ref: '#/definitions/web.HTTPError'
"500":
description: Internal server error.
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Disable totp settings
tags:
- user
/user/settings/totp/enable:
post:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Enables a previously enrolled totp setting by providing a totp passcode.
Fix swagger docs
2020-06-28 16:25:46 +02:00
parameters:
- description: The totp passcode.
in: body
name: totp
required: true
schema:
$ref: '#/definitions/user.TOTPPasscode'
produces:
- application/json
responses:
"200":
description: Successfully enabled
schema:
$ref: '#/definitions/models.Message'
"400":
description: Something's invalid.
schema:
$ref: '#/definitions/web.HTTPError'
"404":
description: User does not exist.
schema:
$ref: '#/definitions/web.HTTPError'
"412":
description: TOTP is not enrolled.
schema:
$ref: '#/definitions/web.HTTPError'
"500":
description: Internal server error.
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Enable a previously enrolled totp setting.
tags:
- user
/user/settings/totp/enroll:
post:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Creates an initial setup for the user in the db. After this step, the user needs to verify they have a working totp setup with the "enable totp" endpoint.
Fix swagger docs
2020-06-28 16:25:46 +02:00
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/user.TOTP'
"400":
description: Something's invalid.
schema:
$ref: '#/definitions/web.HTTPError'
"404":
description: User does not exist.
schema:
$ref: '#/definitions/web.HTTPError'
"500":
description: Internal server error.
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Enroll a user into totp
tags:
- user
/user/settings/totp/qrcode:
get:
consumes:
- application/json
description: Returns a qr code for easier setup at end user's devices.
produces:
- application/json
responses:
"200":
description: The qr code as jpeg image
schema:
type: ""
"500":
description: Internal server error.
schema:
$ref: '#/definitions/models.Message'
security:
- JWTKeyAuth: []
summary: Totp QR Code
tags:
- user
Add user token renew (#113)
2019-12-07 20:52:04 +01:00
/user/token:
post:
consumes:
- application/json
description: Returns a new valid jwt user token with an extended length.
produces:
- application/json
responses:
"200":
description: OK
schema:
Authentication with OpenID Connect providers (#713) Add config docs Lint Move provider-related stuff to separate file Refactor getting auth providers Fix tests Fix user tests Fix openid tests Add swagger docs Fix lint Fix lint issues Fix checking if the user already exists Make sure to create a new namespace for new users Docs Add tests for openid Remove unnessecary err check Consistently return nil users if creating a new user failed Move sending confirmation email to separate function Better variable names Move checks to separate functions Refactor creating user into seperate file Fix creating new local users Test creating new users from different issuers Generate a random username right away if no preferred username has been given Add todo Cache openid providers Add getting int clientids Fix migration Move creating tokens to auth package Add getting or creating a third party user Add parsing claims Add retreiving auth tokens Add token callback from openid package Add check for provider key Add routes Start adding openid auth handler Add config for openid auth Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/713 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
2020-11-21 17:38:58 +01:00
$ref: '#/definitions/auth.Token'
Add user token renew (#113)
2019-12-07 20:52:04 +01:00
"400":
description: Only user token are available for renew.
schema:
$ref: '#/definitions/models.Message'
summary: Renew user token
tags:
- user
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
/users:
get:
consumes:
- application/json
Switch to mage (#651) Add comment about magefile compile Switch make to mage commands in drone Fix misspell Update docs Add general release command Add reprepro command Make sure the filename contains the proper version Add deb package building Add zip command Preserve file permissions when copying files Fix release:os-package Make sure to not create checksums of directories Cleanup Only compress what upx is able to compress Add check command Add release:os-package command Add copy command Add comments Add compress step Move releasing binaries to a more general function and add ones of linux + darwin Add release:windows command Add release:dir command Add namespaces for commands Reorder Add command to run all checks at once Add goconst-check Add gosec-check Add static-check Add gocyclo-check Add ineffasign-check Add misspell-check Add command to check for swagger docs regeneration Add comments Add command to generate swagger docs Reorder Add check for installing golint before running it Add fmt check command Add fmt command Use runAndStreamOutput everywhere Add aliases and comments Add todo Reorder Add test coverage command Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/651
2020-09-03 17:13:19 +02:00
description: Lists all users (without emailadresses). Also possible to search for a specific user.
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
parameters:
- description: Search for a user by its name.
in: query
name: s
type: string
produces:
- application/json
responses:
"200":
description: All (found) users.
schema:
items:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/user.User'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
type: array
"400":
description: Something's invalid.
schema:
Fix swagger docs
2020-06-28 16:25:46 +02:00
$ref: '#/definitions/web.HTTPError'
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
"500":
description: Internal server error.
schema:
$ref: '#/definitions/models.Message'
security:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
- JWTKeyAuth: []
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
summary: Get users
tags:
- user
securityDefinitions:
API Docs improvements (#46)
2019-01-03 23:22:06 +01:00
BasicAuth:
type: basic
JWTKeyAuth:
Migrate to new swagger docs generation (#18)
2018-11-12 16:46:35 +01:00
in: header
name: Authorization
type: apiKey
swagger: "2.0"
Reference in a new issue Copy permalink