do not wrap an example list value in another list

tfranzel · May 31, 2024 · b2c8237 · b2c8237
1 parent 2501bfd
commit b2c8237
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 6 deletions.
diff --git a/drf_spectacular/plumbing.py b/drf_spectacular/plumbing.py
@@ -1408,18 +1408,18 @@ class TmpView(views.APIView):
 
 def build_listed_example_value(value: Any, paginator, direction):
     if not paginator or direction == 'request':
-        return [value]
+        return value if type(value) is list else [value]
 
     sentinel = object()
     schema = paginator.get_paginated_response_schema(sentinel)
 
     if schema is sentinel:
-        return [value]
+        return value if type(value) is list else [value]
 
     def drilldown_schema_example(schema, sentinel):
         # Recursively travel schema properties to build example.
         if schema is sentinel:
-            return [value]
+            return value if type(value) is list else [value]
         if 'properties' in schema.keys():
             return {
                 field_name: drilldown_schema_example(field_schema, sentinel)

diff --git a/tests/test_examples.py b/tests/test_examples.py
@@ -56,6 +56,11 @@ class BSerializer(serializers.Serializer):
             value={"field": 222},
             request_only=True,
         ),
+        OpenApiExample(
+            'Serializer C Example List',
+            value=[{"field": 333}, {"field": 444}],
+            response_only=True,
+        ),
     ]
 )
 class CSerializer(serializers.Serializer):
@@ -180,7 +185,16 @@ class PaginatedExamplesViewSet(ExampleTestWithExtendedViewSet):
                 'results': [{'field': 111}],
             },
             'summary': 'Serializer C Example RO'
-        }
+        },
+        'SerializerCExampleList': {
+            'value': {
+                'count': 123,
+                'next': 'http://api.example.org/accounts/?offset=400&limit=100',
+                'previous': 'http://api.example.org/accounts/?offset=200&limit=100',
+                'results': [{'field': 333}, {'field': 444}],
+            },
+            'summary': 'Serializer C Example List'
+        },
     }
 
 
@@ -236,11 +250,22 @@ class PaginatedExamplesViewSet(ExampleTestWithExtendedViewSet):
                 'results': [{'field': 111}],
             },
             'summary': 'Serializer C Example RO'
-        }
+        },
+        'SerializerCExampleList': {
+            'value': {
+                'pagination': {
+                    'count': 123,
+                    'next': 'http://api.example.org/accounts/?offset=400&limit=100',
+                    'previous': 'http://api.example.org/accounts/?offset=200&limit=100',
+                },
+                'results': [{'field': 333}, {'field': 444}],
+            },
+            'summary': 'Serializer C Example List'
+        },
     }
 
 
-def test_example_request_response_listed_examples(no_warnings):
+def test_example_request_response_singular_examples(no_warnings):
     @extend_schema(
         request=ASerializer(many=True),
         responses=ASerializer(many=True),
@@ -263,6 +288,29 @@ class XView(generics.CreateAPIView):
     }
 
 
+def test_example_request_response_listed_examples(no_warnings):
+    @extend_schema(
+        request=ASerializer(many=True),
+        responses=ASerializer(many=True),
+        examples=[
+            OpenApiExample('Ex', [{'id': '2345'}, {'id': '2345'}])
+        ]
+    )
+    class XView(generics.CreateAPIView):
+        pass
+
+    schema = generate_schema('e', view=XView)
+    operation = schema['paths']['/e']['post']
+    assert operation['requestBody']['content']['application/json'] == {
+        'schema': {'type': 'array', 'items': {'$ref': '#/components/schemas/A'}},
+        'examples': {'Ex': {'value': [{'id': '2345'},{'id': '2345'}]}}
+    }
+    assert operation['responses']['201']['content']['application/json'] == {
+        'schema': {'type': 'array', 'items': {'$ref': '#/components/schemas/A'}},
+        'examples': {'Ex': {'value': [{'id': '2345'},{'id': '2345'}]}}
+    }
+
+
 def test_examples_list_detection_on_non_200_decoration(no_warnings):
     class ExceptionSerializer(serializers.Serializer):
         api_status_code = serializers.CharField()
@@ -375,5 +423,9 @@ class PaginatedExamplesViewSet(ExampleTestWithExtendedViewSet):
         'SerializerCExampleRO': {
             'value': [{'field': 111}],
             'summary': 'Serializer C Example RO'
+        },
+        'SerializerCExampleList': {
+            'value': [{'field': 333}, {'field': 444}],
+            'summary': 'Serializer C Example List'
         }
     }
diff --git a/tests/test_examples.yml b/tests/test_examples.yml
@@ -40,6 +40,11 @@ paths:
                   value:
                   - field: 111
                   summary: Serializer C Example RO
+                SerializerCExampleList:
+                  value:
+                  - field: 333
+                  - field: 444
+                  summary: Serializer C Example List
           description: ''
     post:
       operationId: schema_create