encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-07-28 08:59:54 +03:00
Code Issues Packages Projects Releases Wiki Activity

fixup! Corrected OpenAPI schema type for DecimalField

Browse Source
This commit is contained in:
Clinton Blackburn 2020-04-07 22:23:41 -07:00
parent f80d7be282
commit 9f9913573b
3 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
rest_framework/schemas/openapi.py
View File

@ -445,7 +445,7 @@ class AutoSchema(ViewInspector):
if isinstance(field, serializers.DecimalField): if isinstance(field, serializers.DecimalField):
if getattr(field, 'coerce_to_string', api_settings.COERCE_DECIMAL_TO_STRING): if getattr(field, 'coerce_to_string', api_settings.COERCE_DECIMAL_TO_STRING):
return { content = {
'type': 'string', 'type': 'string',
'format': 'decimal', 'format': 'decimal',
} }
@ -453,6 +453,7 @@ class AutoSchema(ViewInspector):
content = { content = {
'type': 'number' 'type': 'number'
} }
if field.decimal_places: if field.decimal_places:
content['multipleOf'] = float('.' + (field.decimal_places - 1) * '0' + '1') content['multipleOf'] = float('.' + (field.decimal_places - 1) * '0' + '1')
if field.max_whole_digits: if field.max_whole_digits:

11
tests/schemas/test_openapi.py
View File

@ -838,8 +838,15 @@ class TestOperationIntrospection(TestCase):
assert properties['decimal2']['type'] == 'number' assert properties['decimal2']['type'] == 'number'
assert properties['decimal2']['multipleOf'] == .0001 assert properties['decimal2']['multipleOf'] == .0001
assert properties['decimal3'] == {'type': 'string', 'format': 'decimal'} assert properties['decimal3'] == {
assert properties['decimal4'] == {'type': 'string', 'format': 'decimal'} 'type': 'string', 'format': 'decimal', 'maximum': 1000000, 'minimum': -1000000, 'multipleOf': 0.01
}
assert properties['decimal4'] == {
'type': 'string', 'format': 'decimal', 'maximum': 1000000, 'minimum': -1000000, 'multipleOf': 0.01
}
assert properties['decimal5'] == {
'type': 'string', 'format': 'decimal', 'maximum': 10000, 'minimum': -10000, 'multipleOf': 0.01
}
assert properties['email']['type'] == 'string' assert properties['email']['type'] == 'string'
assert properties['email']['format'] == 'email' assert properties['email']['format'] == 'email'

1
tests/schemas/views.py
View File

@ -125,6 +125,7 @@ class ExampleValidatedSerializer(serializers.Serializer):
decimal3 = serializers.DecimalField(max_digits=8, decimal_places=2, coerce_to_string=True) decimal3 = serializers.DecimalField(max_digits=8, decimal_places=2, coerce_to_string=True)
decimal4 = serializers.DecimalField(max_digits=8, decimal_places=2, coerce_to_string=True, decimal4 = serializers.DecimalField(max_digits=8, decimal_places=2, coerce_to_string=True,
validators=(DecimalValidator(max_digits=17, decimal_places=4),)) validators=(DecimalValidator(max_digits=17, decimal_places=4),))
decimal5 = serializers.DecimalField(max_digits=6, decimal_places=2)
email = serializers.EmailField(default='foo@bar.com') email = serializers.EmailField(default='foo@bar.com')
url = serializers.URLField(default='http://www.example.com', allow_null=True) url = serializers.URLField(default='http://www.example.com', allow_null=True)
uuid = serializers.UUIDField() uuid = serializers.UUIDField()