docs: auth docstrings

Issue: #13

src/auth/config.py

@@ -1,9 +1,8 @@
 """
-Configurations for auth module, import auth_settings
+Configurations for the auth module
 
-Configurations:
+Exports:
- - List: Description
+ - auth_settings: Contains OIDC information
- - Configs: Description
 """
 from src.config import CustomBaseSettings
 

src/auth/constants.py

@@ -1,7 +1,3 @@
 """
-Constants and error codes for auth module
+Constants for the auth module
-
-Constants:
- - List: Description
- - Consts: Description
 """

src/auth/dependencies.py

@@ -1,13 +1,11 @@
 """
-Router dependencies for auth module
+Auth dependencies
 
-Classes:
+Exports:
- - List: Description
+ - org_query_user_claims_dependency: bool: Verifies user belongs to org
- - Classes: Description
+ - 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
-Functions:
+ - super_admin_dependency: user_model: verifies the user is a super admin
- - List: Description
- - Functions: Description
 """
 from typing import Annotated
 from fastapi import Depends

src/auth/exceptions.py

@@ -1,9 +1,8 @@
 """
-Module specific exceptions for auth module
+Module specific exceptions for the auth module
 
 Exceptions:
- - List: Description
+ - UnauthorizedException: Takes an optional message string
- - Exceptions: Description
 """
 from typing import Optional
 

src/auth/models.py

@@ -1,7 +1,3 @@
 """
-Database models for auth module
+Database models for the auth module
-
-Models:
- - List: Description
- - Models: Description
 """

src/auth/router.py

@@ -1,8 +1,8 @@
 """
-Router endpoints for auth module
+Router endpoints for the auth module
-Contains oauth registration
 
-Endpoints:
+Exports:
+ - router: fastapi.APIRouter
 """
 from fastapi import APIRouter
 

src/auth/schemas.py

@@ -1,7 +1,3 @@
 """
-Pydantic models for auth module
+Pydantic models for the auth module
-
-Models:
- - List: Description
- - Models: Description
 """

src/auth/service.py

@@ -1,8 +1,8 @@
 """
-Module specific business logic for auth module
+Module specific business logic for the auth module
 
 Exports:
- - claims_dependency
+ - claims_dependency: Dict[str, Any] containing OIDC claims and database ID
 """
 import json
 import requests

src/auth/utils.py

@@ -1,11 +1,3 @@
 """
-Non-business logic reusable functions and classes for auth module
+Non-business logic reusable functions and classes for the auth module
-
-Classes:
- - List: Description
- - Classes: Description
-
-Functions:
- - List: Description
- - Functions: Description
 """