docs: improve documentation of DSP permission system (DEV-1561) #270
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
irinaschubert
approved these changes
Dec 15, 2022
docs/dsp-tools-create.md
Outdated
Comment on lines
178
to
213
| ### Groups | ||
|
|
||
| (optional) | ||
|
|
||
| `"groups": [<group-definition>, <group-definition>,...]` | ||
|
|
||
| The `groups` object contains **project specific** group definitions. As opposed to the | ||
| [**built-in** groups](./dsp-tools-xmlupload.md#groups), the membership of the users to the project specific groups | ||
| can be freely chosen by the `ProjectAdmin`. A project may define several groups such as "student-assistant", | ||
| "editors", etc. in order to provide their members specific permissions. | ||
| The groups that were created here are then available in the XML file in the | ||
| [<permissions> element](dsp-tools-xmlupload.md#permissions-element). | ||
|
|
||
| A project specific group definition has the following elements: | ||
|
|
||
| - _name_ (mandatory): name of the group | ||
| - _descriptions_ (mandatory): description of the group with language tags in the form `"descriptions": {"<lang>": | ||
| "<string>", ...}` (currently, "en", "de", "fr", "it", and "rm" are supported) | ||
| - _selfjoin_ (optional): true if users are allowed to join the group themselves, false (default) if a `ProjectAdmin` has | ||
| to add them | ||
| - _status_ (optional): true (default) if the group is active, false if the group is inactive | ||
|
|
||
| Example: | ||
|
|
||
| ```json | ||
| { | ||
| "groups": [ | ||
| { | ||
| "name": "biz-editors", | ||
| "descriptions": {"en" : "Editors for the BiZ project"}, | ||
| "selfjoin": false, | ||
| "status": true | ||
| } | ||
| ] | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Not sure if we should include this in the documentation as it is currently not supported by DSP-APP. Maybe we could at least add a sentence like "Groups are currently not supported by the DSP-APP. Therefore, it is discouraged to use groups."
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
resolves DEV-1561