Vikunja
/
api
mirror of https://kolaente.dev/vikunja/api.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: remove all traces of namespaces

This commit is contained in:
kolaente 2023-04-03 11:58:12 +02:00
parent 9011894a29
commit 3b0935d033
No known key found for this signature in database
GPG Key ID: F40E70337AB24C9B
7 changed files with 29 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -26,13 +26,7 @@ If you find any security-related issues you don't want to disclose publicly, ple
## Features ## Features
* Create TODO lists with tasks See [the features page](https://vikunja.io/features/) on our website for a more exaustive list or
* Reminder for tasks
* Namespaces: A "group" which bundles multiple lists
* Share lists and namespaces with teams and users with granular permissions
* Plenty of details for tasks
See [the features page](https://vikunja.io/en/features/) on our website for a more exaustive list or
try it on [try.vikunja.io](https://try.vikunja.io)! try it on [try.vikunja.io](https://try.vikunja.io)!
## Docs ## Docs

5
docs/content/doc/development/migration.md
View File

@ -100,9 +100,10 @@ You should also document the routes with [swagger annotations]({{< ref "swagger-
## Insertion helper method ## Insertion helper method
There is a method available in the `migration` package which takes a fully nested Vikunja structure and creates it with all relations. There is a method available in the `migration` package which takes a fully nested Vikunja structure and creates it with all relations.
This means you start by adding a namespace, then add projects inside that namespace, then tasks in the lists and so on. This means you start by adding a project, then add projects inside that project, then tasks in the lists and so on.
In general, it is reccommended to have one root project with all projects of the other service as child projects.
The root structure must be present as `[]*models.NamespaceWithProjectsAndTasks`. It allows to represent all of Vikunja's hierarchy as a single data structure. The root structure must be present as `[]*models.ProjectWithTasksAndBuckets`. It allows to represent all of Vikunja's hierarchy as a single data structure.
Then call the method like so: Then call the method like so:

11
docs/content/doc/development/swagger-docs.md
View File

@ -25,7 +25,7 @@ As an example, this is the definition of a project with all comments:
type Project struct { type Project struct {
// The unique, numeric id of this project. // The unique, numeric id of this project.
ID int64 `xorm:"bigint autoincr not null unique pk" json:"id" param:"project"` ID int64 `xorm:"bigint autoincr not null unique pk" json:"id" param:"project"`
// The title of the project. You'll see this in the namespace overview. // The title of the project. You'll see this in the overview.
Title string `xorm:"varchar(250) not null" json:"title" valid:"required,runelength(1|250)" minLength:"1" maxLength:"250"` Title string `xorm:"varchar(250) not null" json:"title" valid:"required,runelength(1|250)" minLength:"1" maxLength:"250"`
// The description of the project. // The description of the project.
Description string `xorm:"longtext null" json:"description"` Description string `xorm:"longtext null" json:"description"`
@ -34,13 +34,14 @@ type Project struct {
// The hex color of this project // The hex color of this project
HexColor string `xorm:"varchar(6) null" json:"hex_color" valid:"runelength(0|6)" maxLength:"6"` HexColor string `xorm:"varchar(6) null" json:"hex_color" valid:"runelength(0|6)" maxLength:"6"`
OwnerID int64 `xorm:"bigint INDEX not null" json:"-"` OwnerID int64 `xorm:"bigint INDEX not null" json:"-"`
NamespaceID int64 `xorm:"bigint INDEX not null" json:"namespace_id" param:"namespace"` ParentProjectID int64 `xorm:"bigint INDEX null" json:"parent_project_id"`
ParentProject *Project `xorm:"-" json:"-"`
// The user who created this project. // The user who created this project.
Owner *user.User `xorm:"-" json:"owner" valid:"-"` Owner *user.User `xorm:"-" json:"owner" valid:"-"`
// Whether or not a project is archived. // Whether a project is archived.
IsArchived bool `xorm:"not null default false" json:"is_archived" query:"is_archived"` IsArchived bool `xorm:"not null default false" json:"is_archived" query:"is_archived"`
// The id of the file this project has set as background // The id of the file this project has set as background
@ -50,7 +51,7 @@ type Project struct {
// Contains a very small version of the project background to use as a blurry preview until the actual background is loaded. Check out https://blurha.sh/ to learn how it works. // Contains a very small version of the project background to use as a blurry preview until the actual background is loaded. Check out https://blurha.sh/ to learn how it works.
BackgroundBlurHash string `xorm:"varchar(50) null" json:"background_blur_hash"` BackgroundBlurHash string `xorm:"varchar(50) null" json:"background_blur_hash"`
// True if a project is a favorite. Favorite projects show up in a separate namespace. This value depends on the user making the call to the api. // True if a project is a favorite. Favorite projects show up in a separate parent project. This value depends on the user making the call to the api.
IsFavorite bool `xorm:"-" json:"is_favorite"` IsFavorite bool `xorm:"-" json:"is_favorite"`
// The subscription status for the user reading this project. You can only read this property, use the subscription endpoints to modify it. // The subscription status for the user reading this project. You can only read this property, use the subscription endpoints to modify it.

1
docs/content/doc/development/translation-instructions-german.md
View File

@ -67,7 +67,6 @@ Beispiel: „Benutzer:in“
| Englisches Original | Verwendung in deutscher Übersetzung | | Englisches Original | Verwendung in deutscher Übersetzung |
| ------------------- | -------------------- | | ------------------- | -------------------- |
| Bucket | Spalte | | Bucket | Spalte |
| Namespace | Namespace |
| Link Share | Linkfreigabe | | Link Share | Linkfreigabe |
| Username | Anmeldename | | Username | Anmeldename |

21
docs/content/doc/usage/errors.md
View File

@ -54,16 +54,17 @@ This document describes the different errors Vikunja can return.
## Project ## Project
| ErrorCode | HTTP Status Code | Description | | ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------------------------------------------------------------------------------------------------------------------------| |-----------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
| 3001 | 404 | The project does not exist. | | 3001 | 404 | The project does not exist. |
| 3004 | 403 | The user needs to have read permissions on that project to perform that action. | | 3004 | 403 | The user needs to have read permissions on that project to perform that action. |
| 3005 | 400 | The project title cannot be empty. | | 3005 | 400 | The project title cannot be empty. |
| 3006 | 404 | The project share does not exist. | | 3006 | 404 | The project share does not exist. |
| 3007 | 400 | A project with this identifier already exists. | | 3007 | 400 | A project with this identifier already exists. |
| 3008 | 412 | The project is archived and can therefore only be accessed read only. This is also true for all tasks associated with this project. | | 3008 | 412 | The project is archived and can therefore only be accessed read only. This is also true for all tasks associated with this project. |
| 3009 | 412 | The project cannot belong to a dynamically generated namespace like "Favorites". | | 3009 | 412 | The project cannot belong to a dynamically generated parent project like "Favorites". |
| 3010 | 412 | This project cannot be a child of itself.| | 3010 | 412 | This project cannot be a child of itself. |
| 3011 | 412 | This project cannot have a cyclic relationship to a parent project. |
## Task ## Task

14
docs/content/doc/usage/rights.md
View File

@ -8,20 +8,20 @@ menu:
parent: "usage" parent: "usage"
--- ---
# Project and namespace rights for teams and users # Project rights for teams and users
Whenever you share a project or namespace with a user or team, you can specify a `rights` parameter. Whenever you share a project with a user or team, you can specify a `rights` parameter.
This parameter controls the rights that team or user is going to have (or has, if you request the current sharing status). This parameter controls the rights that team or user is going to have (or has, if you request the current sharing status).
Rights are being specified using integers. Rights are being specified using integers.
The following values are possible: The following values are possible:
| Right (int) | Meaning | | Right (int) | Meaning |
|-------------|---------------------------------------------------------------------------------------------------------------| |-------------|-------------------------------------------------------------------------------------------------|
| 0 (Default) | Read only. Anything which is shared with this right cannot be edited. | | 0 (Default) | Read only. Anything which is shared with this right cannot be edited. |
| 1 | Read and write. Namespaces or projects shared with this right can be read and written to by the team or user. | | 1 | Read and write. Projects shared with this right can be read and written to by the team or user. |
| 2 | Admin. Can do anything like read and write, but can additionally manage sharing options. | | 2 | Admin. Can do anything like read and write, but can additionally manage sharing options. |
## Team admins ## Team admins

2
pkg/models/error.go
View File

@ -343,7 +343,7 @@ func (err *ErrProjectCannotHaveACyclicRelationship) HTTPError() web.HTTPError {
return web.HTTPError{ return web.HTTPError{
HTTPCode: http.StatusPreconditionFailed, HTTPCode: http.StatusPreconditionFailed,
Code: ErrCodeProjectCannotHaveACyclicRelationship, Code: ErrCodeProjectCannotHaveACyclicRelationship,
Message: "This project cannot have a cyclic relationship to a parent project", Message: "This project cannot have a cyclic relationship to a parent project.",
} }
} }