versia-pub/server
2
0
Fork 0
mirror of https://github.com/versia-pub/server.git synced 2025-12-06 16:38:19 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs(api): 🐛 Add proper parameters to Roles API docs

Browse source
This commit is contained in:
Jesse Wierzbinski 2024-11-28 10:59:14 +01:00
parent eb405d33cd
commit 594e8ca4e6
No known key found for this signature in database
1 changed files with 19 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/api/roles.md
View file

@ -118,7 +118,9 @@ Get a list of all roles on the instance.
- `0.7.0`: Added. - `0.7.0`: Added.
- `0.8.0`: Now returns all instance roles. - `0.8.0`: Now returns all instance roles.
### Example ### Request
#### Example
```http ```http
GET /api/v1/roles GET /api/v1/roles
@ -305,6 +307,14 @@ Create a new role.
### Request ### Request
- `name` (string, required): The name of the role.
- 1-128 characters.
- `permissions` (array of strings, optional): The permissions granted by the role. Defaults to an empty array.
- `priority` (number, optional): The priority of the role. Defaults to `0`.
- `description` (string, optional): A description of the role.
- `visible` (boolean, optional): Whether the role is visible in the UI. Defaults to `false`.
- `icon` (string, optional): An icon URL for the role.
#### Example #### Example
```http ```http
@ -396,6 +406,14 @@ Update a role's data.
### Request ### Request
- `name` (string, required): The name of the role.
- 1-128 characters.
- `permissions` (array of strings, optional): The permissions granted by the role. Defaults to an empty array.
- `priority` (number, optional): The priority of the role. Defaults to `0`.
- `description` (string, optional): A description of the role.
- `visible` (boolean, optional): Whether the role is visible in the UI. Defaults to `false`.
- `icon` (string, optional): An icon URL for the role.
#### Example #### Example
```http ```http