Fix discarded falsy examples values #1049

tfranzel · Aug 8, 2023 · afe8b3b · afe8b3b
1 parent 388da8d
commit afe8b3b
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 2 deletions.
diff --git a/drf_spectacular/plumbing.py b/drf_spectacular/plumbing.py
@@ -34,6 +34,7 @@
 from django.utils.translation import gettext_lazy as _
 from rest_framework import exceptions, fields, mixins, serializers, versioning
 from rest_framework.compat import unicode_http_header
+from rest_framework.fields import empty
 from rest_framework.settings import api_settings
 from rest_framework.test import APIRequestFactory
 from rest_framework.utils.mediatypes import _MediaType
@@ -322,7 +323,7 @@ def build_examples_list(examples):
  for example in examples:
  normalized_name = inflection.camelize(example.name.replace(' ', '_'))
  sub_schema = {}
- if example.value:
+ if example.value is not empty:
  sub_schema['value'] = example.value
  if example.external_value:
  sub_schema['externalValue'] = example.external_value

diff --git a/drf_spectacular/utils.py b/drf_spectacular/utils.py
@@ -161,7 +161,7 @@ class OpenApiExample(OpenApiSchemaBase):
  def __init__(
  self,
  name: str,
- value: Any = None,
+ value: Any = empty,
  external_value: str = '',
  summary: _StrOrPromise = '',
  description: _StrOrPromise = '',

diff --git a/tests/test_examples.py b/tests/test_examples.py
@@ -271,3 +271,31 @@ class XListView(generics.ListAPIView):
  'schema': {'$ref': '#/components/schemas/Simple'},
  'examples': {'AnExample': {'value': {'id': 3}, 'summary': 'an example'}}
  }
+
+
+def test_examples_with_falsy_values(no_warnings):
+ @extend_schema(
+ responses=OpenApiResponse(
+ description='something',
+ response=OpenApiTypes.JSON_PTR,
+ examples=[
+ OpenApiExample('one', value=1),
+ OpenApiExample('empty-list', value=[]),
+ OpenApiExample('false', value=False),
+ OpenApiExample('zero', value=0),
+ OpenApiExample('empty'),
+ ],
+ ),
+ )
+ class XListView(generics.ListAPIView):
+ model = SimpleModel
+ serializer_class = SimpleSerializer
+
+ schema = generate_schema('/x/', view=XListView)
+ assert schema['paths']['/x/']['get']['responses']['200']['content']['application/json']['examples'] == {
+ 'One': {'summary': 'one', 'value': 1},
+ 'Empty-list': {'summary': 'empty-list', 'value': []},
+ 'False': {'summary': 'false', 'value': False},
+ 'Zero': {'summary': 'zero', 'value': 0},
+ 'Empty': {'summary': 'empty'},
+ }