nerdcult
/
api
4
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(api): added information about the users role in a project to the /user/projects endpoint

This commit is contained in:
antifallobst 2023-08-19 00:05:53 +02:00
parent 291b75b34d
commit 9f74df134c
Signed by: antifallobst
GPG Key ID: 2B4F402172791BAF
2 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/README.md
View File

@ -28,5 +28,4 @@ The token for this can be aquired using the `/account/authenticate` endpoint.
- Password checking on registration
- usage examples
- anonymized account deletion reason
- account bound rate limit
- return role in /user/projects
- account bound rate limit

6
docs/user/projects.md
View File

@ -14,9 +14,9 @@ Setting none or two parameters will result in a _400 Bad Request_ Response.
## Responses
### 200 - Success
__Content - JSON:__
| Field | Description |
|----------|-------------------------------------------|
| projects | A list of (projectname, projectid) pairs. |
| Field | Description |
|----------|-------------------------------------------------|
| projects | A list of (projectname, projectid, role) pairs. |
### 400 - Error: Bad Request
The request was malformed.
### 403 - Error: Forbidden