django-ninja-aio-crud 2.12.2__tar.gz → 2.13.0__tar.gz

{django_ninja_aio_crud-2.12.2 → django_ninja_aio_crud-2.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-ninja-aio-crud
-Version: 2.12.2
+Version: 2.13.0
 Summary: Django Ninja AIO CRUD - Rest Framework
 Author: Giuseppe Casillo
 Requires-Python: >=3.10, <3.15

{django_ninja_aio_crud-2.12.2 → django_ninja_aio_crud-2.13.0}/docs/api/views/api_view_set.md

@@ -293,6 +293,7 @@ Relations are declared via `M2MRelationSchema` objects (not tuples). Each schema
 - `related_schema`: optional pre-built schema for the related model (auto-generated if the `model` is a `ModelSerializer`)
 - `serializer_class`: optional `Serializer` class for plain Django models. When provided, `related_schema` is auto-generated from the serializer. Cannot be used when `model` is a `ModelSerializer`.
 - `append_slash`: bool to control trailing slash for the GET relation endpoint path. Defaults to `False` (no trailing slash) for backward compatibility. When `True`, the GET path ends with a trailing slash.
+- `verbose_name_plural`: optional human-readable plural name for the related model, used in endpoint summaries and descriptions. When not provided, defaults to the related model's `_meta.verbose_name_plural`.
 
 If `path` is empty it falls back to the related model verbose name (lowercase plural).
 If `filters` is provided, a per-relation filters schema is auto-generated and exposed on the GET relation endpoint:
@@ -475,6 +476,19 @@ M2MRelationSchema(
 )
 ```
 
+Example with custom verbose name:
+
+```python
+M2MRelationSchema(
+    model=Tag,
+    related_name="tags",
+    verbose_name_plural="Article Tags",  # Used in summaries: "Get Article Tags", "Add or Remove Article Tags"
+    add=True,
+    remove=True,
+    get=True,
+)
+```
+
 ## Custom Views
 
 Preferred (decorators): see the section above.

{django_ninja_aio_crud-2.12.2 → django_ninja_aio_crud-2.13.0}/ninja_aio/__init__.py

@@ -1,6 +1,6 @@
 """Django Ninja AIO CRUD - Rest Framework"""
 
-__version__ = "2.12.2"
+__version__ = "2.13.0"
 
 from .api import NinjaAIO
 

{django_ninja_aio_crud-2.12.2 → django_ninja_aio_crud-2.13.0}/ninja_aio/helpers/api.py

@@ -358,6 +358,7 @@ class ManyToManyAPI:
         related_schema,
         filters_schema,
         append_slash: bool,
+        verbose_name_plural: str,
     ):
         @self.router.get(
             self._get_api_path(rel_path, append_slash=append_slash),
@@ -366,8 +367,8 @@ class ManyToManyAPI:
                 self.view_set.error_codes: GenericMessageSchema,
             },
             auth=m2m_auth,
-            summary=f"Get {rel_util.model._meta.verbose_name_plural.capitalize()}",
-            description=f"Get all related {rel_util.model._meta.verbose_name_plural.capitalize()}",
+            summary=f"Get {verbose_name_plural}",
+            description=f"Get all related {verbose_name_plural}",
         )
         @decorate_view(
             unique_view(f"get_{self.related_model_util.model_name}_{rel_path}"),
@@ -402,13 +403,13 @@ class ManyToManyAPI:
         related_model: ModelSerializer | Model,
         related_name: str,
         m2m_auth,
-        rel_util: ModelUtil,
         rel_path: str,
         m2m_add: bool,
         m2m_remove: bool,
+        verbose_name_plural: str,
     ):
         action, schema_in = self._resolve_action_schema(m2m_add, m2m_remove)
-        plural = rel_util.model._meta.verbose_name_plural.capitalize()
+        plural = verbose_name_plural
         summary = f"{action} {plural}"
 
         @self.router.post(
@@ -478,6 +479,10 @@ class ManyToManyAPI:
         m2m_add, m2m_remove, m2m_get = relation.add, relation.remove, relation.get
         filters_schema = self.relations_filters_schemas.get(related_name)
         append_slash = relation.append_slash
+        verbose_name_plural = (
+            relation.verbose_name_plural
+            or rel_util.model._meta.verbose_name_plural.capitalize()
+        )
 
         if m2m_get:
             self._register_get_relation_view(
@@ -488,6 +493,7 @@ class ManyToManyAPI:
                 related_schema=related_schema,
                 filters_schema=filters_schema,
                 append_slash=append_slash,
+                verbose_name_plural=verbose_name_plural,
             )
 
         if m2m_add or m2m_remove:
@@ -495,10 +501,10 @@ class ManyToManyAPI:
                 related_model=model,
                 related_name=related_name,
                 m2m_auth=m2m_auth,
-                rel_util=rel_util,
                 rel_path=rel_path,
                 m2m_add=m2m_add,
                 m2m_remove=m2m_remove,
+                verbose_name_plural=verbose_name_plural,
             )
 
     def _add_views(self):

{django_ninja_aio_crud-2.12.2 → django_ninja_aio_crud-2.13.0}/ninja_aio/models/serializers.py

@@ -424,10 +424,9 @@ class BaseSerializer:
     @classmethod
     def _warn_missing_relation_serializer(cls, field_name: str, model) -> None:
         """Emit warning for reverse relations without explicit serializer mapping."""
-        if (
-            not isinstance(model, ModelSerializerMeta)
-            and not getattr(settings, "NINJA_AIO_TESTING", False)
-        ) or getattr(settings, "NINJA_AIO_RAISE_SERIALIZATION_WARNINGS", False):
+        if not isinstance(model, ModelSerializerMeta) and getattr(
+            settings, "NINJA_AIO_RAISE_SERIALIZATION_WARNINGS", True
+        ):
             warnings.warn(
                 f"{cls.__name__}: reverse relation '{field_name}' is listed in read fields "
                 "but has no entry in relations_serializers; it will be auto-resolved only "

{django_ninja_aio_crud-2.12.2 → django_ninja_aio_crud-2.13.0}/ninja_aio/schemas/helpers.py

@@ -44,7 +44,9 @@ class M2MRelationSchema(BaseModel):
             it can be used to auto-generate the `related_schema`.
         append_slash (bool):
             Whether to append a trailing slash to the generated GET endpoint path. Defaults to False for backward compatibility.
-
+        verbose_name_plural (str | None):
+            Optional human-readable plural name for the related model, used in documentation and responses.
+            
     Validation:
         - If `model` is not a ModelSerializerMeta, `related_schema` is required.
         - When `model` is a ModelSerializerMeta and `related_schema` is not provided, it will be
@@ -69,6 +71,7 @@ class M2MRelationSchema(BaseModel):
     related_schema: Optional[Type[Schema]] = None
     serializer_class: Optional[SerializerMeta] = None
     append_slash: bool = False
+    verbose_name_plural: Optional[str] = None
 
     model_config = ConfigDict(arbitrary_types_allowed=True)
 

{django_ninja_aio_crud-2.12.2 → django_ninja_aio_crud-2.13.0}/tests/test_settings.py

@@ -47,4 +47,4 @@ LOGGING = {
     },
 }
 
-NINJA_AIO_TESTING = True
+NINJA_AIO_RAISE_SERIALIZATION_WARNINGS = False