set resource type on data layer

Author: mahenzon

fastapi_jsonapi/api.py

@@ -95,16 +95,16 @@ def __init__(
         self.list_views = None
         self.detail_view_resource: Type["DetailViewBase"] = class_detail
         self.list_view_resource: Type["ListViewBase"] = class_list
-        self._type: str = resource_type
+        self.type_: str = resource_type
         self._schema: Type[BaseModel] = schema
         self.schema_list: Type[BaseModel] = schema
         self.model: Type[TypeModel] = model
         self.schema_detail = schema
 
-        if self._type in self.all_jsonapi_routers:
-            msg = f"Resource type {self._type!r} already registered"
+        if self.type_ in self.all_jsonapi_routers:
+            msg = f"Resource type {self.type_!r} already registered"
             raise ValueError(msg)
-        self.all_jsonapi_routers[self._type] = self
+        self.all_jsonapi_routers[self.type_] = self
 
         self.pagination_default_size: Optional[int] = pagination_default_size
         self.pagination_default_number: Optional[int] = pagination_default_number
@@ -150,7 +150,7 @@ def get_endpoint_name(
         :param kind: list / detail
         :return:
         """
-        return f"{action}_{self._type}_{kind}"
+        return f"{action}_{self.type_}_{kind}"
 
     def _register_get_resource_list(self, path: str):
         list_response_example = {
@@ -161,7 +161,7 @@ def _register_get_resource_list(self, path: str):
             tags=self._tags,
             responses=list_response_example | self.default_error_responses,
             methods=["GET"],
-            summary=f"Get list of `{self._type}` objects",
+            summary=f"Get list of `{self.type_}` objects",
             endpoint=self._create_get_resource_list_view(),
             name=self.get_endpoint_name("get", "list"),
         )
@@ -175,7 +175,7 @@ def _register_post_resource_list(self, path: str):
             tags=self._tags,
             responses=create_resource_response_example | self.default_error_responses,
             methods=["POST"],
-            summary=f"Create object `{self._type}`",
+            summary=f"Create object `{self.type_}`",
             status_code=status.HTTP_201_CREATED,
             endpoint=self._create_post_resource_list_view(),
             name=self.get_endpoint_name("create", "list"),
@@ -190,7 +190,7 @@ def _register_delete_resource_list(self, path: str):
             tags=self._tags,
             responses=detail_response_example | self.default_error_responses,
             methods=["DELETE"],
-            summary=f"Delete objects `{self._type}` by filters",
+            summary=f"Delete objects `{self.type_}` by filters",
             endpoint=self._create_delete_resource_list_view(),
             name=self.get_endpoint_name("delete", "list"),
         )
@@ -206,7 +206,7 @@ def _register_get_resource_detail(self, path: str):
             tags=self._tags,
             responses=detail_response_example | self.default_error_responses,
             methods=["GET"],
-            summary=f"Get object `{self._type}` by id",
+            summary=f"Get object `{self.type_}` by id",
             endpoint=self._create_get_resource_detail_view(),
             name=self.get_endpoint_name("get", "detail"),
         )
@@ -222,7 +222,7 @@ def _register_patch_resource_detail(self, path: str):
             tags=self._tags,
             responses=detail_response_example | self.default_error_responses,
             methods=["PATCH"],
-            summary=f"Patch object `{self._type}` by id",
+            summary=f"Patch object `{self.type_}` by id",
             endpoint=self._create_patch_resource_detail_view(),
             name=self.get_endpoint_name("update", "detail"),
         )
@@ -238,7 +238,7 @@ def _register_delete_resource_detail(self, path: str):
             tags=self._tags,
             responses=detail_response_example | self.default_error_responses,
             methods=["DELETE"],
-            summary=f"Delete object `{self._type}` by id",
+            summary=f"Delete object `{self.type_}` by id",
             endpoint=self._create_delete_resource_detail_view(),
             name=self.get_endpoint_name("delete", "detail"),
         )

fastapi_jsonapi/data_layers/base.py

@@ -46,15 +46,18 @@ def __init__(
         id_name_field: Optional[str] = None,
         disable_collection_count: bool = False,
         default_collection_count: int = -1,
+        type_: str = "",
         **kwargs,
     ):
         """
+
         :param schema:
         :param model:
         :param url_id_field:
         :param id_name_field:
         :param disable_collection_count:
         :param default_collection_count:
+        :param type_: resource type
         :param kwargs:
         """
         self.model = model
@@ -64,6 +67,7 @@ def __init__(
         self.disable_collection_count: bool = disable_collection_count
         self.default_collection_count: int = default_collection_count
         self.is_atomic = False
+        self.type_ = type_
 
     async def atomic_start(self, previous_dl: Optional["BaseDataLayer"] = None):
         self.is_atomic = True

fastapi_jsonapi/views/view_base.py

@@ -66,6 +66,7 @@ def _get_data_layer(self, schema: Type[BaseModel], **dl_kwargs):
         return self.data_layer_cls(
             schema=schema,
             model=self.jsonapi.model,
+            type_=self.jsonapi.type_,
             **dl_kwargs,
         )