Set the proper JSON schema type for HStoreFields in OpenAPI schemas (#6914)

Lucidiot · kevin-brown · commit 39bd6cc5cb69 · 2019-10-27T21:13:01.000-04:00
diff --git a/rest_framework/schemas/openapi.py b/rest_framework/schemas/openapi.py
@@ -344,6 +344,7 @@ def _map_field(self, field):
             serializers.BooleanField: 'boolean',
             serializers.JSONField: 'object',
             serializers.DictField: 'object',
+            serializers.HStoreField: 'object',
         }
         return {'type': FIELD_CLASS_SCHEMA_TYPE.get(field.__class__, 'string')}
 
diff --git a/tests/schemas/test_openapi.py b/tests/schemas/test_openapi.py
@@ -462,6 +462,22 @@ def test_serializer_datefield(self):
         assert properties['date']['format'] == 'date'
         assert properties['datetime']['format'] == 'date-time'
 
+    def test_serializer_hstorefield(self):
+        path = '/'
+        method = 'GET'
+        view = create_view(
+            views.ExampleGenericAPIView,
+            method,
+            create_request(path),
+        )
+        inspector = AutoSchema()
+        inspector.view = view
+
+        responses = inspector._get_responses(path, method)
+        response_schema = responses['200']['content']['application/json']['schema']
+        properties = response_schema['items']['properties']
+        assert properties['hstore']['type'] == 'object'
+
     def test_serializer_validators(self):
         path = '/'
         method = 'GET'
diff --git a/tests/schemas/views.py b/tests/schemas/views.py
@@ -33,6 +33,7 @@ def get(self, *args, **kwargs):
 class ExampleSerializer(serializers.Serializer):
     date = serializers.DateField()
     datetime = serializers.DateTimeField()
+    hstore = serializers.HStoreField()
 
 
 class ExampleGenericAPIView(generics.GenericAPIView):

Original file line number	Diff line number	Diff line change
`@@ -344,6 +344,7 @@ def _map_field(self, field):`
`344`	`344`	`serializers.BooleanField: 'boolean',`
`345`	`345`	`serializers.JSONField: 'object',`
`346`	`346`	`serializers.DictField: 'object',`
	`347`	`+ serializers.HStoreField: 'object',`
`347`	`348`	`}`
`348`	`349`	`return {'type': FIELD_CLASS_SCHEMA_TYPE.get(field.__class__, 'string')}`
`349`	`350`