update annotations and examples

Author: mahenzon

README.md

@@ -56,7 +56,7 @@ Base = declarative_base()
 class User(Base):
     __tablename__ = "users"
     id = Column(Integer, primary_key=True, autoincrement=True)
-    name: str = Column(Text, nullable=True)
+    name = Column(Text, nullable=True)
 
 
 class UserAttributesBaseSchema(BaseModel):
@@ -145,9 +145,9 @@ def add_routes(app: FastAPI):
         },
     ]
 
-    routers: APIRouter = APIRouter()
+    router: APIRouter = APIRouter()
     RoutersJSONAPI(
-        router=routers,
+        router=router,
         path="/user",
         tags=["User"],
         class_detail=UserDetailView,
@@ -159,7 +159,7 @@ def add_routes(app: FastAPI):
         model=User,
     )
 
-    app.include_router(routers, prefix="")
+    app.include_router(router, prefix="")
     return tags
 
 

docs/python_snippets/client_generated_id/schematic_example.py

@@ -3,14 +3,14 @@
 
 import uvicorn
 from fastapi import APIRouter, Depends, FastAPI
-from pydantic import Field, BaseModel as PydanticBaseModel
+from fastapi_jsonapi.schema_base import Field, BaseModel as PydanticBaseModel
 from sqlalchemy import Column, Integer, Text
 from sqlalchemy.engine import make_url
 from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
 from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.orm import sessionmaker
 
-from fastapi_jsonapi import RoutersJSONAPI
+from fastapi_jsonapi import RoutersJSONAPI, init
 from fastapi_jsonapi.misc.sqla.generics.base import DetailViewBaseGeneric, ListViewBaseGeneric
 from fastapi_jsonapi.views.utils import HTTPMethod, HTTPMethodConfig
 from fastapi_jsonapi.views.view_base import ViewBase
@@ -27,7 +27,7 @@
 class User(Base):
     __tablename__ = "users"
     id = Column(Integer, primary_key=True, autoincrement=False)
-    name: str = Column(Text, nullable=True)
+    name = Column(Text, nullable=True)
 
 
 class BaseModel(PydanticBaseModel):
@@ -77,7 +77,7 @@ class Config:
         arbitrary_types_allowed = True
 
 
-def session_dependency_handler(view: ViewBase, dto: BaseModel) -> dict:
+def session_dependency_handler(view: ViewBase, dto: SessionDependency) -> dict:
     return {"session": dto.session}
 
 
@@ -107,9 +107,9 @@ def add_routes(app: FastAPI):
         },
     ]
 
-    routers: APIRouter = APIRouter()
+    router: APIRouter = APIRouter()
     RoutersJSONAPI(
-        router=routers,
+        router=router,
         path="/user",
         tags=["User"],
         class_detail=UserDetailView,
@@ -121,7 +121,7 @@ def add_routes(app: FastAPI):
         model=User,
     )
 
-    app.include_router(routers, prefix="")
+    app.include_router(router, prefix="")
     return tags
 
 
@@ -139,6 +139,7 @@ def create_app() -> FastAPI:
     )
     add_routes(app)
     app.on_event("startup")(sqlalchemy_init)
+    init(app)
     return app
 
 

examples/api_minimal.py

@@ -20,23 +20,22 @@
 CURRENT_DIR = CURRENT_FILE.parent
 PROJECT_DIR = CURRENT_DIR.parent.parent
 DB_URL = f"sqlite+aiosqlite:///{CURRENT_DIR}/db.sqlite3"
+# DB_URL = f"sqlite+:///{CURRENT_DIR}/db.sqlite3"
 sys.path.append(str(PROJECT_DIR))
 
 Base = declarative_base()
 
 
 class User(Base):
     __tablename__ = "users"
-    id = Column(Integer, primary_key=True, autoincrement=True)
-    name: str = Column(Text, nullable=True)
+    id = Column(Integer, primary_key=True)
+    name = Column(Text, nullable=True)
 
 
 class UserAttributesBaseSchema(BaseModel):
     name: str
 
     class Config:
-        """Pydantic schema config."""
-
         orm_mode = True
 
 
@@ -117,21 +116,19 @@ def add_routes(app: FastAPI):
         },
     ]
 
-    routers: APIRouter = APIRouter()
+    router: APIRouter = APIRouter()
     RoutersJSONAPI(
-        router=routers,
+        router=router,
         path="/user",
         tags=["User"],
         class_detail=UserDetailView,
         class_list=UserListView,
         schema=UserSchema,
-        resource_type="user",
-        schema_in_patch=UserPatchSchema,
-        schema_in_post=UserInSchema,
         model=User,
+        resource_type="user",
     )
 
-    app.include_router(routers, prefix="")
+    app.include_router(router, prefix="")
     return tags
 
 

fastapi_jsonapi/exceptions/json_api.py

@@ -4,6 +4,7 @@
 from typing import (
     List,
     Optional,
+    Union,
 )
 
 from fastapi import HTTPException as FastApiHttpException
@@ -19,7 +20,7 @@ class HTTPException(FastApiHttpException):
 
     def __init__(
         self,
-        detail: str = "",
+        detail: Union[str, dict] = "",
         pointer: str = "",
         parameter: str = "",
         title: Optional[str] = None,