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

docs: user router summaries

Browse source 
Issue: #13
This commit is contained in:
Chris Milne 2026-05-28 16:11:54 +01:00
parent f7efbfcfc5
commit cba04e4249
1 changed files with 32 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

48
src/user/router.py
View file

@ -23,9 +23,13 @@ router = APIRouter(
) )
@router.get("/self/claims", response_model=OIDCClaims, status_code=status.HTTP_200_OK, responses={ @router.get("/self/claims",
status.HTTP_200_OK: {"description": "Successful retrieval from database"}, summary="Get current user OIDC claims.",
}) response_model=OIDCClaims,
status_code=status.HTTP_200_OK,
responses={
status.HTTP_200_OK: {"description": "Successful retrieval from database"},
})
async def current_user_claims(user: claims_dependency): async def current_user_claims(user: claims_dependency):
""" """
Returns the full OIDC claims associated with the currently logged-in user. Returns the full OIDC claims associated with the currently logged-in user.
@ -34,10 +38,14 @@ async def current_user_claims(user: claims_dependency):
return user return user
@router.get("/self/db", response_model=UserResponse, status_code=status.HTTP_200_OK, responses={ @router.get("/self/db",
status.HTTP_404_NOT_FOUND: {"description": "User not found"}, summary="Get current user hub details.",
status.HTTP_200_OK: {"description": "Successful retrieval from database"}, response_model=UserResponse,
}) status_code=status.HTTP_200_OK,
responses={
status.HTTP_404_NOT_FOUND: {"description": "User not found"},
status.HTTP_200_OK: {"description": "Successful retrieval from database"},
})
async def current_user(user_model: user_model_claims_dependency): async def current_user(user_model: user_model_claims_dependency):
""" """
Returns the database details associated with the currently logged-in user. Returns the database details associated with the currently logged-in user.
@ -45,10 +53,14 @@ async def current_user(user_model: user_model_claims_dependency):
return user_model return user_model
@router.get("/", response_model=UserResponse, status_code=status.HTTP_200_OK, responses={ @router.get("/",
status.HTTP_404_NOT_FOUND: {"description": "User not found"}, summary="Get user hub details by ID.",
status.HTTP_200_OK: {"description": "Successful retrieval from database"}, response_model=UserResponse,
}) status_code=status.HTTP_200_OK,
responses={
status.HTTP_404_NOT_FOUND: {"description": "User not found"},
status.HTTP_200_OK: {"description": "Successful retrieval from database"},
})
async def get_user_by_id(user_model: user_model_query_dependency, su: super_admin_dependency): async def get_user_by_id(user_model: user_model_query_dependency, su: super_admin_dependency):
""" """
Returns the database details associated with the provided user ID. Returns the database details associated with the provided user ID.
@ -56,11 +68,15 @@ async def get_user_by_id(user_model: user_model_query_dependency, su: super_admi
return user_model return user_model
@router.delete("/", status_code=status.HTTP_204_NO_CONTENT, responses={ @router.delete("/",
status.HTTP_204_NO_CONTENT: {"description": "User deleted"}, summary="Delete user from hub by ID.",
status.HTTP_404_NOT_FOUND: {"description": "User not found"}, status_code=status.HTTP_204_NO_CONTENT,
}) responses={
async def delete_user_by_id(db: db_dependency, user_model: user_model_body_dependency, su: super_admin_dependency, request_model: UserDeleteUserRequest): status.HTTP_204_NO_CONTENT: {"description": "User deleted"},
status.HTTP_404_NOT_FOUND: {"description": "User not found"},
})
async def delete_user_by_id(db: db_dependency, user_model: user_model_body_dependency, su: super_admin_dependency,
request_model: UserDeleteUserRequest):
""" """
Deletes the user with the provided ID from the database. This will not remove them from OIDC, and they will be automatically readded on next login. Deletes the user with the provided ID from the database. This will not remove them from OIDC, and they will be automatically readded on next login.
""" """