sr2/cloud-api
6
0
Fork 1
Code Issues 8 Pull requests 2 Projects Releases Packages Wiki Activity Actions

docs: user docstrings

Browse source 
Issue: #13
This commit is contained in:
Chris Milne 2026-05-28 14:55:44 +01:00
parent d852bda091
commit 43cb7e700d
9 changed files with 23 additions and 49 deletions
Download patch file Download diff file Expand all files Collapse all files

14
src/user/router.py
View file

@ -1,15 +1,11 @@
"""
Router endpoints for user module
Router endpoints for the user module
Endpoints:
- [get]/self/claims - Retrieves user's OIDC claims
- [get]/self/db - Retrieves the user data from the db that corresponds to the current OIDC user
- [get]/self/orgs - Retrieves all organisations associated with the current user
- [get]/self/orgs/admin - Retrieves only admin organisations for the current user
- [get]/{user_id} - Retrieves a specific user by their ID
- [get]/{user_id}/orgs - Retrieves all organisations associated with a specific user
- [get]/{user_id}/orgs/admin - Retrieves only admin organisations for a specific user
- [delete]/{user_id} - Deletes a user from the db by their db ID
- [GET](/user/self/claims): [OIDC claims]: Returns all OIDC claims associated with the currently logged-in user.
- [GET](/user/self/db): [OIDC claims]: Returns details about the currently logged-in user from the hub db.
- [GET](/user/): [super admin]: Returns user(id) details.
- [DELETE](/user/): [super admin]: Removes a User(id) from the hub database.
"""
from fastapi import APIRouter
from starlette import status