Skip to content

Commit

Permalink
Draft: add app, database and sshusers to scope documentation (#89)
Browse files Browse the repository at this point in the history
* add app, database and sshusers to scope documentation

* format

* fix documentation for contributor state

---------

Co-authored-by: Frederic Reisenhauer <[email protected]>
  • Loading branch information
freisenhauer and freisenhauer-mittwald authored Aug 7, 2024
1 parent 78bb1a3 commit 86c24c7
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 2 deletions.
27 changes: 27 additions & 0 deletions docs/contribution/3-overview/3-concepts/3-scopes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,26 +43,53 @@ Die derzeit verfügbaren Scopes sind:
- `customer:delete`

- Contract

- `contract:read`
- `contract:write`
- `contract:delete`

- Project

- `project:read`
- `project:write`
- `project:delete`

- Domain

- `domain:read`
- `domain:write`
- `domain:delete`

- Mail

- `mail:read`
- `mail:write`
- `mail:delete`

- User

- `user:read`
- `user:write`
- `user:delete`

- SSH/SFTP User

- `sshuser:read`
- `sshuser:write`
- `sshuser:delete`

- Database

- `database:read`
- `database:write`
- `database:delete`

- App

- `app:read`
- `app:write`
- `app:delete`

mittwald arbeitet daran, weitere Scopes zu implementieren und die Verfügbarkeit der Scopes zu erweitern.
Wenn ein Scope benötigt wird, der nicht in dieser Liste aufgeführt ist, kann dieser [bei mittwald angefragt werden](../../../how-to/support/).
Es wird sich darum bemüht, den Scope zeitnah zur Verfügung zu stellen.
Expand Down
11 changes: 9 additions & 2 deletions docs/contribution/6-reference/1-contributor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,16 @@ Die benötigten und erlaubten Attribute sind in folgendem Schema beschrieben.
"ID der Organisation im mStudio, zu der der Contributor gehört. Ein Contributor hat ein 1:1 Verhältnis zu einer Organisation",
},
state: {
type: "string",
enum: ["enabled", "disabled"],
type: "object",
description: "Status des Contributoren.",
example: {
disabled: false,
},
properties: {
disabled: {
type: "boolean",
},
},
},
email: {
type: "string",
Expand Down

0 comments on commit 86c24c7

Please sign in to comment.