Fixed docs, added custom security_scheme, increased tracerite version

Author: mr-fatalyst

docs/api_reference/errors.md

@@ -194,13 +194,7 @@ Content-Type: application/json
     "type": "validation_error",
     "message": "Validation error",
     "status": 422,
-    "details": [
-      {
-        "loc": ["body", "email"],
-        "msg": "value is not a valid email address",
-        "type": "value_error.email"
-      }
-    ]
+    "details": "Value is not a valid email address"
   }
 }
 ```
@@ -606,9 +600,7 @@ All errors follow this structure:
     "type": "error_type_identifier",
     "message": "Human-readable error message",
     "status": 400,
-    "details": {
-      // Optional additional details
-    }
+    "details": "Optional additional details (string, included only when provided)"
   }
 }
 ```

docs/frameworks/django.md

@@ -186,7 +186,7 @@ from fastopenapi import Path
 def get_user(user_id: int = Path(..., description="User ID")):
     return {"user_id": user_id}
 
-# Django URL: /users/<int:user_id>
+# Django URL: /users/<user_id>
 ```
 
 ## Request Data

docs/guide/error_handling.md

@@ -99,15 +99,9 @@ All errors return a standardized JSON format:
 {
   "error": {
     "type": "validation_error",
-    "message": "Validation error",
+    "message": "Error parsing parameter 'email'",
     "status": 422,
-    "details": [
-      {
-        "loc": ["body", "email"],
-        "msg": "Invalid email format",
-        "type": "value_error"
-      }
-    ]
+    "details": "Value is not a valid email address"
   }
 }
 ```

fastopenapi/core/router.py

@@ -37,7 +37,9 @@ def __init__(
         title: str = "My App",
         version: str = "0.1.0",
         description: str = "API documentation",
-        security_scheme: SecuritySchemeType | None = SecuritySchemeType.BEARER_JWT,
+        security_scheme: (
+            SecuritySchemeType | dict | None
+        ) = SecuritySchemeType.BEARER_JWT,
     ):
         self.app = app
         self.docs_url = docs_url
@@ -53,8 +55,25 @@ def __init__(
         self._global_security = []
 
         if security_scheme:
-            scheme_name = SECURITY_SCHEME_NAMES[security_scheme]
-            self._security_schemes = {scheme_name: SECURITY_SCHEMES[security_scheme]}
+            if isinstance(security_scheme, dict):
+                scheme_type = security_scheme.get("type", "")
+                http_scheme = security_scheme.get("scheme", "")
+                if scheme_type == "http" and http_scheme == "bearer":
+                    name = "BearerAuth"
+                elif scheme_type == "http" and http_scheme == "basic":
+                    name = "BasicAuth"
+                elif scheme_type == "apiKey":
+                    name = "ApiKeyAuth"
+                elif scheme_type == "oauth2":
+                    name = "OAuth2"
+                else:
+                    name = "CustomAuth"
+                self._security_schemes = {name: security_scheme}
+            else:
+                scheme_name = SECURITY_SCHEME_NAMES[security_scheme]
+                self._security_schemes = {
+                    scheme_name: SECURITY_SCHEMES[security_scheme]
+                }
 
         # Register documentation endpoints if app is provided
         if self.app is not None and all([docs_url, redoc_url, openapi_url]):

pyproject.toml

@@ -69,5 +69,4 @@ trio = "^0.29.0"
 pytest-asyncio = "^0.25.3"
 coverage = "^7.6.12"
 mkdocs-material = "^9.6.11"
-# Temporary fix https://github.com/sanic-org/tracerite/issues/20
-tracerite = "1.1.1"
+tracerite = "^1.1.3"

tests/core/test_base_router.py

@@ -129,6 +129,50 @@ def test_include_router_merges_security_schemes_both(self):
         assert "BearerAuth" in parent._security_schemes
         assert "ApiKey" in parent._security_schemes
 
+    def test_security_scheme_dict_bearer(self):
+        """Test security_scheme as dict with bearer type"""
+        router = BaseRouter(
+            security_scheme={
+                "type": "http",
+                "scheme": "bearer",
+                "bearerFormat": "JWT",
+                "description": "Custom bearer",
+            }
+        )
+        assert router._security_schemes is not None
+        assert "BearerAuth" in router._security_schemes
+        assert router._security_schemes["BearerAuth"]["description"] == "Custom bearer"
+
+    def test_security_scheme_dict_oauth2(self):
+        """Test security_scheme as dict with oauth2 type"""
+        router = BaseRouter(
+            security_scheme={
+                "type": "oauth2",
+                "flows": {"password": {"tokenUrl": "/token", "scopes": {}}},
+            }
+        )
+        assert "OAuth2" in router._security_schemes
+
+    def test_security_scheme_dict_apikey(self):
+        """Test security_scheme as dict with apiKey type"""
+        router = BaseRouter(
+            security_scheme={"type": "apiKey", "in": "header", "name": "X-My-Key"}
+        )
+        assert "ApiKeyAuth" in router._security_schemes
+        assert router._security_schemes["ApiKeyAuth"]["name"] == "X-My-Key"
+
+    def test_security_scheme_dict_basic(self):
+        """Test security_scheme as dict with basic auth type"""
+        router = BaseRouter(security_scheme={"type": "http", "scheme": "basic"})
+        assert "BasicAuth" in router._security_schemes
+
+    def test_security_scheme_dict_custom(self):
+        """Test security_scheme as dict with unknown type"""
+        router = BaseRouter(
+            security_scheme={"type": "openIdConnect", "openIdConnectUrl": "/openid"}
+        )
+        assert "CustomAuth" in router._security_schemes
+
     def test_include_router_merges_global_security(self):
         """Test that include_router merges global security from sub-router"""
         parent = BaseRouter(security_scheme=None)