Swagger UI: Simplify #31 #167

backend/app/api/routes/documents.py

@@ -73,7 +73,10 @@ def upload_doc(
     return APIResponse.success_response(data)
 
 
-@router.get("/rm/{doc_id}", response_model=APIResponse[Document])
+@router.get(
+    "/rm/{doc_id}",
+    response_model=APIResponse[Document],
+)
 def delete_doc(
     session: SessionDep,
     current_user: CurrentUser,

backend/app/api/routes/login.py

@@ -50,15 +50,15 @@ def login_access_token(
     )
 
 
-@router.post("/login/test-token", response_model=UserPublic)
+@router.post("/login/test-token", response_model=UserPublic, include_in_schema=False)
 def test_token(current_user: CurrentUser) -> Any:
     """
     Test access token
     """
     return current_user
 
 
-@router.post("/password-recovery/{email}")
+@router.post("/password-recovery/{email}", include_in_schema=False)
 def recover_password(email: str, session: SessionDep) -> Message:
     """
     Password Recovery
@@ -82,7 +82,7 @@ def recover_password(email: str, session: SessionDep) -> Message:
     return Message(message="Password recovery email sent")
 
 
-@router.post("/reset-password/")
+@router.post("/reset-password/", include_in_schema=False)
 def reset_password(session: SessionDep, body: NewPassword) -> Message:
     """
     Reset password
@@ -109,6 +109,7 @@ def reset_password(session: SessionDep, body: NewPassword) -> Message:
     "/password-recovery-html-content/{email}",
     dependencies=[Depends(get_current_active_superuser)],
     response_class=HTMLResponse,
+    include_in_schema=False,
 )
 def recover_password_html_content(email: str, session: SessionDep) -> Any:
     """

backend/app/api/routes/organization.py

@@ -91,6 +91,7 @@ def update_organization(
     "/{org_id}",
     dependencies=[Depends(get_current_active_superuser)],
     response_model=APIResponse[None],
+    include_in_schema=False,
 )
 def delete_organization(session: SessionDep, org_id: int):
     org = get_organization_by_id(session=session, org_id=org_id)

backend/app/api/routes/private.py

@@ -20,7 +20,7 @@ class PrivateUserCreate(BaseModel):
     is_verified: bool = False
 
 
-@router.post("/users/", response_model=UserPublic)
+@router.post("/users/", response_model=UserPublic, include_in_schema=False)
 def create_user(user_in: PrivateUserCreate, session: SessionDep) -> Any:
     """
     Create a new user.

backend/app/api/routes/project.py

@@ -87,7 +87,11 @@ def update_project(*, session: SessionDep, project_id: int, project_in: ProjectU
 
 
 # Delete a project
-@router.delete("/{project_id}", dependencies=[Depends(get_current_active_superuser)])
+@router.delete(
+    "/{project_id}",
+    dependencies=[Depends(get_current_active_superuser)],
+    include_in_schema=False,
+)
 def delete_project(session: SessionDep, project_id: int):
     project = get_project_by_id(session=session, project_id=project_id)
     if project is None:

backend/app/api/routes/project_user.py

@@ -17,7 +17,9 @@
 
 
 # Add a user to a project
-@router.post("/{user_id}", response_model=APIResponse[ProjectUserPublic])
+@router.post(
+    "/{user_id}", response_model=APIResponse[ProjectUserPublic], include_in_schema=False
+)
 def add_user(
     request: Request,
     user_id: uuid.UUID,
@@ -52,7 +54,9 @@ def add_user(
 
 
 # Get all users in a project
-@router.get("/", response_model=APIResponse[list[ProjectUserPublic]])
+@router.get(
+    "/", response_model=APIResponse[list[ProjectUserPublic]], include_in_schema=False
+)
 def list_project_users(
     session: Session = Depends(get_db),
     current_user: UserProjectOrg = Depends(verify_user_project_organization),
@@ -72,7 +76,9 @@ def list_project_users(
 
 
 # Remove a user from a project
-@router.delete("/{user_id}", response_model=APIResponse[Message])
+@router.delete(
+    "/{user_id}", response_model=APIResponse[Message], include_in_schema=False
+)
 def remove_user(
     request: Request,
     user_id: uuid.UUID,

backend/app/api/routes/users.py

@@ -32,6 +32,7 @@
     "/",
     dependencies=[Depends(get_current_active_superuser)],
     response_model=UsersPublic,
+    include_in_schema=False,
 )
 def read_users(session: SessionDep, skip: int = 0, limit: int = 100) -> Any:
     """
@@ -48,7 +49,10 @@ def read_users(session: SessionDep, skip: int = 0, limit: int = 100) -> Any:
 
 
 @router.post(
-    "/", dependencies=[Depends(get_current_active_superuser)], response_model=UserPublic
+    "/",
+    dependencies=[Depends(get_current_active_superuser)],
+    response_model=UserPublic,
+    include_in_schema=False,
 )
 def create_user_endpoint(*, session: SessionDep, user_in: UserCreate) -> Any:
     """
@@ -154,7 +158,7 @@ def register_user(session: SessionDep, user_in: UserRegister) -> Any:
     return user
 
 
-@router.get("/{user_id}", response_model=UserPublic)
+@router.get("/{user_id}", response_model=UserPublic, include_in_schema=False)
 def read_user_by_id(
     user_id: uuid.UUID, session: SessionDep, current_user: CurrentUser
 ) -> Any:
@@ -176,6 +180,7 @@ def read_user_by_id(
     "/{user_id}",
     dependencies=[Depends(get_current_active_superuser)],
     response_model=UserPublic,
+    include_in_schema=False,
 )
 def update_user_endpoint(
     *,
@@ -204,7 +209,11 @@ def update_user_endpoint(
     return db_user
 
 
-@router.delete("/{user_id}", dependencies=[Depends(get_current_active_superuser)])
+@router.delete(
+    "/{user_id}",
+    dependencies=[Depends(get_current_active_superuser)],
+    include_in_schema=False,
+)
 def delete_user(
     session: SessionDep, current_user: CurrentUser, user_id: uuid.UUID
 ) -> Message:

backend/app/api/routes/utils.py

@@ -12,6 +12,7 @@
     "/test-email/",
     dependencies=[Depends(get_current_active_superuser)],
     status_code=201,
+    include_in_schema=False,
 )
 def test_email(email_to: EmailStr) -> Message:
     """
@@ -26,6 +27,6 @@ def test_email(email_to: EmailStr) -> Message:
     return Message(message="Test email sent")
 
 
-@router.get("/health/")
+@router.get("/health/", include_in_schema=False)
 async def health_check() -> bool:
     return True