Merge pull request #69 from ghazi-git/avoid-ignoring-extend_schema_serializer-examples

avoid-ignoring-extend_schema_serializer-examples

Author: ghazi-git

docs/changelog.md

@@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### Fixed
 - enforce support of only drf-spectacular 0.27 and newer in pyproject.toml
+- ensure examples from `@extend_schema_serializer` are not ignored when adding error response examples
 
 ## [0.13.0] - 2024-02-28
 ### Changed

drf_standardized_errors/openapi.py

@@ -337,5 +337,14 @@ def _get_extra_validation_errors(self) -> Dict[str, Set[str]]:
 
         return extra_codes_by_field
 
-    def get_examples(self) -> list:
-        return get_error_examples()
+    def _get_examples(
+        self, serializer, direction, media_type, status_code=None, extras=None
+    ):
+        all_examples = (extras or []) + get_error_examples()
+        return super()._get_examples(
+            serializer,
+            direction,
+            media_type,
+            status_code=status_code,
+            extras=all_examples,
+        )

tests/test_openapi.py

@@ -7,9 +7,11 @@
 from drf_spectacular.types import OpenApiTypes
 from drf_spectacular.utils import (
     OpenApiCallback,
+    OpenApiExample,
     OpenApiResponse,
     PolymorphicProxySerializer,
     extend_schema,
+    extend_schema_serializer,
     inline_serializer,
 )
 from rest_framework import serializers
@@ -621,3 +623,36 @@ def test_get_view_does_not_raise_missing_serializer_warning(capsys):
 def test_schema_generated(api_client):
     response = api_client.get("/schema/")
     assert response.status_code == 200
+
+
+@extend_schema_serializer(
+    examples=[
+        OpenApiExample(
+            "extend_schema_serializer_example",
+            summary="short summary",
+            value={"field": "specific_value"},
+            response_only=True,
+        ),
+    ]
+)
+class SomeSerializer(serializers.Serializer):
+    field = serializers.CharField()
+
+
+class ExtendSchemaSerializerView(GenericAPIView):
+    serializer_class = SomeSerializer
+
+    def get(self, request, *args, **kwargs):
+        serializer = self.get_serializer(instance={"field": "value1"})
+        return Response(serializer.data)
+
+
+def test_examples_from_extend_schema_serializer_are_showing_up(api_client):
+    view = ExtendSchemaSerializerView.as_view()
+    schema = generate_view_schema("extend_schema_serializer/", view)
+    resp200 = schema["paths"]["/extend_schema_serializer/"]["get"]["responses"]["200"]
+    assert "examples" in resp200["content"]["application/json"]
+    examples = resp200["content"]["application/json"]["examples"]
+    assert (
+        examples["ExtendSchemaSerializerExample"]["value"]["field"] == "specific_value"
+    )