From 5d4f74f90dfb9f81850433361bc73ad28c5541e8 Mon Sep 17 00:00:00 2001 From: Patrick Ogenstad Date: Tue, 1 Sep 2020 20:51:07 +0200 Subject: [PATCH] Allow example=False Currently with a Boolean field it isn't possible to set the example to 'False' since it would instead be set to None. Fixes #206 --- flask_restx/fields.py | 2 +- tests/test_fields.py | 8 ++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/flask_restx/fields.py b/flask_restx/fields.py index 8cd835ff..3212856c 100644 --- a/flask_restx/fields.py +++ b/flask_restx/fields.py @@ -156,7 +156,7 @@ def __init__( self.description = description self.required = required self.readonly = readonly - self.example = example or self.__schema_example__ + self.example = example if example is not None else self.__schema_example__ self.mask = mask def format(self, value): diff --git a/tests/test_fields.py b/tests/test_fields.py index 49c17c07..0a5312cf 100644 --- a/tests/test_fields.py +++ b/tests/test_fields.py @@ -298,6 +298,14 @@ def test_with_default(self): assert not field.required assert field.__schema__ == {"type": "boolean", "default": True} + def test_with_example(self): + field = fields.Boolean(default=True, example=False) + assert field.__schema__ == { + "type": "boolean", + "default": True, + "example": False, + } + @pytest.mark.parametrize( "value,expected", [