Merge pull request #40 from mts-ai/feature/openapi-generation-fix

fixed openapi generation

Author: mahenzon

fastapi_jsonapi/data_layers/base.py

@@ -5,11 +5,12 @@
 """
 
 import types
-from typing import List, Optional, Tuple, Type
+from typing import Dict, List, Optional, Tuple, Type
 
 from fastapi_jsonapi.data_typing import TypeModel, TypeSchema
 from fastapi_jsonapi.querystring import QueryStringManager
 from fastapi_jsonapi.schema import BaseJSONAPIItemInSchema
+from fastapi_jsonapi.schema_builder import FieldConfig, TransferSaveWrapper
 
 
 class BaseDataLayer:
@@ -75,6 +76,38 @@ async def atomic_start(self, previous_dl: Optional["BaseDataLayer"] = None):
     async def atomic_end(self, success: bool = True):
         raise NotImplementedError
 
+    def _unwrap_field_config(self, extra: Dict):
+        field_config_wrapper: Optional[TransferSaveWrapper] = extra.get("field_config")
+
+        if field_config_wrapper:
+            return field_config_wrapper.get_field_config()
+
+        return FieldConfig()
+
+    def _apply_client_generated_id(
+        self,
+        data_create: BaseJSONAPIItemInSchema,
+        model_kwargs: dict,
+    ):
+        """
+        :param data_create: the data validated by pydantic.
+        :param model_kwargs: the data validated by pydantic.
+        """
+        if data_create.id is None:
+            return model_kwargs
+
+        extra = data_create.__fields__["id"].field_info.extra
+        if extra.get("client_can_set_id"):
+            id_value = data_create.id
+            field_config = self._unwrap_field_config(extra)
+
+            if field_config.cast_type:
+                id_value = field_config.cast_type(id_value)
+
+            model_kwargs["id"] = id_value
+
+        return model_kwargs
+
     async def create_object(self, data_create: BaseJSONAPIItemInSchema, view_kwargs: dict) -> TypeModel:
         """
         Create an object

fastapi_jsonapi/data_layers/sqla_orm.py

@@ -184,27 +184,6 @@ async def apply_relationships(self, obj: TypeModel, data_create: BaseJSONAPIItem
             # todo: relation name may be different?
             setattr(obj, relation_name, related_data)
 
-    def _apply_client_generated_id(
-        self,
-        data_create: BaseJSONAPIItemInSchema,
-        model_kwargs: dict,
-    ):
-        """
-        :param data_create: the data validated by pydantic.
-        :param model_kwargs: the data validated by pydantic.
-        """
-        if data_create.id is None:
-            return model_kwargs
-
-        extra = data_create.__fields__["id"].field_info.extra
-        if extra.get("client_can_set_id"):
-            id_value = data_create.id
-            if cast_type := extra.get("id_cast_func"):
-                id_value = cast_type(id_value)
-            model_kwargs["id"] = id_value
-
-        return model_kwargs
-
     async def create_object(self, data_create: BaseJSONAPIItemInSchema, view_kwargs: dict) -> TypeModel:
         """
         Create an object through sqlalchemy.

fastapi_jsonapi/schema_builder.py

@@ -46,6 +46,28 @@
 # todo: when 3.9 support is dropped, return back `slots=True to JSONAPIObjectSchemas dataclass`
 
 
+class FieldConfig:
+    cast_type: Callable
+
+    def __init__(self, cast_type: Optional[Callable] = None):
+        self.cast_type = cast_type
+
+
+class TransferSaveWrapper:
+    """
+    Types doesn't allowed to be passed as keywords to pydantic Field,
+    so this exists to help save them
+
+    In other case OpenAPI generation will fail
+    """
+
+    def __init__(self, field_config: FieldConfig):
+        def get_field_config() -> FieldConfig:
+            return field_config
+
+        self.get_field_config = get_field_config
+
+
 @dataclass(frozen=True)
 class JSONAPIObjectSchemas:
     attributes_schema: Type[BaseModel]
@@ -479,7 +501,9 @@ def _build_jsonapi_object(
             **field_info.extra,
         }
         if id_cast_func:
-            id_field_kw.update(id_cast_func=id_cast_func)
+            id_field_kw.update(
+                field_config=TransferSaveWrapper(field_config=FieldConfig(cast_type=id_cast_func)),
+            )
 
         object_jsonapi_schema_fields = {
             "attributes": (attributes_schema, ...),

tests/test_api/test_api_sqla_with_includes.py

@@ -3,7 +3,7 @@
 from itertools import chain, zip_longest
 from json import dumps
 from typing import Dict, List
-from uuid import uuid4
+from uuid import UUID, uuid4
 
 from fastapi import APIRouter, FastAPI, status
 from httpx import AsyncClient
@@ -1667,6 +1667,22 @@ async def test_openapi_endpoint_ok(self, client: AsyncClient, app: FastAPI):
         resp = response.json()
         assert isinstance(resp, dict)
 
+    async def test_openapi_for_client_can_set_id(self):
+        class Schema(BaseModel):
+            id: UUID = Field(client_can_set_id=True)
+
+        app = build_app_custom(
+            model=User,
+            schema=Schema,
+            schema_in_post=Schema,
+            schema_in_patch=Schema,
+            resource_type="openapi_case_1",
+        )
+
+        async with AsyncClient(app=app, base_url="http://test") as client:
+            response = await client.get(app.openapi_url)
+            assert response.status_code == status.HTTP_200_OK, response.text
+
 
 class TestFilters:
     async def test_filters_really_works(