From 9f74df134c7679717902a9a1859e6944da14b602 Mon Sep 17 00:00:00 2001 From: antifallobst Date: Sat, 19 Aug 2023 00:05:53 +0200 Subject: [PATCH] docs(api): added information about the users role in a project to the /user/projects endpoint --- docs/README.md | 3 +-- docs/user/projects.md | 6 +++--- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/README.md b/docs/README.md index db6997a..9c746a8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 \ No newline at end of file +- account bound rate limit \ No newline at end of file diff --git a/docs/user/projects.md b/docs/user/projects.md index bf7d642..d228767 100644 --- a/docs/user/projects.md +++ b/docs/user/projects.md @@ -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