docs: auth docstrings

Issue: #13
This commit is contained in:
Chris Milne 2026-05-28 11:10:55 +01:00
parent a86cfea65a
commit 42349b0182
9 changed files with 20 additions and 44 deletions

View file

@ -1,13 +1,11 @@
"""
Router dependencies for auth module
Auth dependencies
Classes:
- List: Description
- Classes: Description
Functions:
- List: Description
- Functions: Description
Exports:
- org_query_user_claims_dependency: bool: Verifies user belongs to org
- org_model_root_claim_query_dependency: org_model: verifies org exists and user is either root or su, gets org from query
- org_model_root_claim_body_dependency: org_model: verifies org exists and user is either root or su, gets org from body
- super_admin_dependency: user_model: verifies the user is a super admin
"""
from typing import Annotated
from fastapi import Depends