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

updated docs

Browse source
This commit is contained in:
kolaente 2018-10-06 15:41:57 +02:00
parent c5100aad42
commit 75b611de48
No known key found for this signature in database
GPG key ID: F40E70337AB24C9B
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/concepts.md
View file

@ -6,7 +6,7 @@ functions and respective web handlers, all represented through interfaces.
## CRUDable ## CRUDable
This interface defines methods to Create/Read/ReadAll/Update/Delete something. In order to use the common web This interface defines methods to Create/Read/ReadAll/Update/Delete something. In order to use the common web
handler, the struct must implement this and the `rights` interface. handler, the struct must implement this and the `Rights` interface.
The interface is defined as followed: The interface is defined as followed:
@ -54,9 +54,12 @@ type Rights interface {
``` ```
When using the standard web handler, all methods except `CanRead()` are called before their `CRUD` counterparts. `CanRead()` When using the standard web handler, all methods except `CanRead()` are called before their `CRUD` counterparts. `CanRead()`
is called after `Read()` was invoked as this would otherwise mean getting an object from the db to check if the user has the is called after `ReadOne()` was invoked as this would otherwise mean getting an object from the db to check if the user has the
right to see it and then getting it again if thats the case. Calling the function afterwards means we only have to get the right to see it and then getting it again if thats the case. Calling the function afterwards means we only have to get the
object once. object once.
## Standard web handler ## Standard web handler
## Errors
Error types with their messages and http-codes are set in `models/error.go`. If the error type implements `HTTPError`, the server returns a user-friendly error message when this error occours. This means it returns a good HTTP status code, a message, and an error code. The error code should be unique across all error codes and can be used on the client to show a localized error message or do other stuff based on the exact error the server returns. That way the client won't have to "guess" that the error message remains the same over multiple versions of Vikunja.