More docs

Featurecreep.md

@@ -85,16 +85,17 @@ Sorry for some of them being in German, I'll tranlate them at some point.
 
 * [ ] Bauanleitung in die Readme/docs
   * [x] Auch noch nen "link" zum Featurecreep
+* [x] Redocs
+* [x] Swaggerdocs verbessern
+  * [x] Descriptions in structs
+  * [x] Maxlength specify etc. (see swaggo docs)
+* [x] Rights
 * [ ] Anleitung zum Makefile
 * [ ] Struktur erklären
-* [ ] Backups
 * [ ] Deploy in die docs
   * [ ] Docker
   * [ ] Native (systemd + nginx/apache)
-* [ ] Redocs
-* [ ] Swaggerdocs verbessern
-  * [ ] Descriptions in structs
-  * [x] Maxlength specify etc. (see swaggo docs)
+* [ ] Backups
 * [ ] Docs aufsetzen
 
 ### Tasks

docs/rights.md

@@ -0,0 +1,19 @@
+# List and namespace rights for teams and users
+
+Whenever you share a list or namespace 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).
+
+Rights are being specified using integers.
+
+The following values are possible:
+
+| Right (int) | Meaning |
+|-------------|---------|
+| 0 (Default) | Read only. Anything which is shared with this right cannot be edited. |
+| 1 | Read and write. Namespaces or lists 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. |
+
+### Team admins
+
+When adding or querying a team, every member has an additional boolean value stating if it is admin or not.
+A team admin can also add and remove team members and also change whether a user in the team is admin or not.

pkg/models/teams.go

@@ -73,7 +73,6 @@ type TeamMember struct {
 
 	// A unix timestamp when this relation was created. You cannot change this value.
 	Created int64 `xorm:"created" json:"created"`
-	// A unix timestamp when this relation was last updated. You cannot change this value.
 
 	web.CRUDable `xorm:"-" json:"-"`
 	web.Rights   `xorm:"-" json:"-"`
@@ -86,7 +85,8 @@ func (TeamMember) TableName() string {
 
 // TeamUser is the team member type
 type TeamUser struct {
-	User  `xorm:"extends"`
+	User `xorm:"extends"`
+	// Wheter or not the member is an admin of the team. See the docs for more about what a team admin can do
 	Admin bool `json:"admin"`
 }