mirror of
https://github.com/Significant-Gravitas/AutoGPT.git
synced 2026-04-08 03:00:28 -04:00
de78d062a9
We'll soon be needing a more feature-complete external API. To make way for this, I'm moving some files around so: - We can more easily create new versions of our external API - The file structure of our internal API is more homogeneous These changes are quite opinionated, but IMO in any case they're better than the chaotic structure we have now. ### Changes 🏗️ - Move `backend/server` -> `backend/api` - Move `backend/server/routers` + `backend/server/v2` -> `backend/api/features` - Change absolute sibling imports to relative imports - Move `backend/server/v2/AutoMod` -> `backend/executor/automod` - Combine `backend/server/routers/analytics_*test.py` -> `backend/api/features/analytics_test.py` - Sort OpenAPI spec file ### Checklist 📋 #### For code changes: - [x] I have clearly listed my changes in the PR description - [x] I have made a test plan - [x] I have tested my changes according to the test plan: - CI tests - [x] Clicking around in the app -> no obvious breakage
65 lines
2.2 KiB
Python
65 lines
2.2 KiB
Python
from fastapi import FastAPI
|
|
|
|
from .jwt_utils import bearer_jwt_auth
|
|
|
|
|
|
def add_auth_responses_to_openapi(app: FastAPI) -> None:
|
|
"""
|
|
Patch a FastAPI instance's `openapi()` method to add 401 responses
|
|
to all authenticated endpoints.
|
|
|
|
This is needed when using HTTPBearer with auto_error=False to get proper
|
|
401 responses instead of 403, but FastAPI only automatically adds security
|
|
responses when auto_error=True.
|
|
"""
|
|
# Wrap current method to allow stacking OpenAPI schema modifiers like this
|
|
wrapped_openapi = app.openapi
|
|
|
|
def custom_openapi():
|
|
if app.openapi_schema:
|
|
return app.openapi_schema
|
|
|
|
openapi_schema = wrapped_openapi()
|
|
|
|
# Add 401 response to all endpoints that have security requirements
|
|
for path, methods in openapi_schema["paths"].items():
|
|
for method, details in methods.items():
|
|
security_schemas = [
|
|
schema
|
|
for auth_option in details.get("security", [])
|
|
for schema in auth_option.keys()
|
|
]
|
|
if bearer_jwt_auth.scheme_name not in security_schemas:
|
|
continue
|
|
|
|
if "responses" not in details:
|
|
details["responses"] = {}
|
|
|
|
details["responses"]["401"] = {
|
|
"$ref": "#/components/responses/HTTP401NotAuthenticatedError"
|
|
}
|
|
|
|
# Ensure #/components/responses exists
|
|
if "components" not in openapi_schema:
|
|
openapi_schema["components"] = {}
|
|
if "responses" not in openapi_schema["components"]:
|
|
openapi_schema["components"]["responses"] = {}
|
|
|
|
# Define 401 response
|
|
openapi_schema["components"]["responses"]["HTTP401NotAuthenticatedError"] = {
|
|
"description": "Authentication required",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {"detail": {"type": "string"}},
|
|
}
|
|
}
|
|
},
|
|
}
|
|
|
|
app.openapi_schema = openapi_schema
|
|
return app.openapi_schema
|
|
|
|
app.openapi = custom_openapi
|