Adjust schema get_filter_fields rules to match framework (#5454)

Carlton Gibson · web-flow · commit b1c6ea124069 · 2017-09-27T09:13:10.000+02:00
Closes #5237 Generics/ModelViewset performs filtering on: list, retrieve, put, patch and destroy (plus method equivalents). i.e. on list plus anything that calls `get_object`. This PR makes schema generation follow that. It adds `AutoSchema._allows_filters()` which can be overridden in subclasses. I’ve made this initially “private” so we can make quick changes if needs be in a 3.7.1 etc.
diff --git a/rest_framework/schemas/inspectors.py b/rest_framework/schemas/inspectors.py
@@ -337,18 +337,33 @@ def get_pagination_fields(self, path, method):
         paginator = view.pagination_class()
         return paginator.get_schema_fields(view)
 
-    def get_filter_fields(self, path, method):
-        view = self.view
+    def _allows_filters(self, path, method):
+        """
+        Determine whether to include filter Fields in schema.
 
-        if not is_list_view(path, method, view):
-            return []
+        Default implementation looks for ModelViewSet or GenericAPIView
+        actions/methods that cause filtering on the default implementation.
+
+        Override to adjust behaviour for your view.
 
-        if not getattr(view, 'filter_backends', None):
+        Note: Introduced in v3.7: Initially "private" (i.e. with leading underscore)
+            to allow changes based on user experience.
+        """
+        if getattr(self.view, 'filter_backends', None) is None:
+            return False
+
+        if hasattr(self.view, 'action'):
+            return self.view.action in ["list", "retrieve", "update", "partial_update", "destroy"]
+
+        return method.lower in ["get", "put", "patch", "delete"]
+
+    def get_filter_fields(self, path, method):
+        if not self._allows_filters(path, method):
             return []
 
         fields = []
-        for filter_backend in view.filter_backends:
-            fields += filter_backend().get_schema_fields(view)
+        for filter_backend in self.view.filter_backends:
+            fields += filter_backend().get_schema_fields(self.view)
         return fields
 
     def get_encoding(self, path, method):
diff --git a/tests/test_schemas.py b/tests/test_schemas.py
@@ -139,7 +139,8 @@ def test_anonymous_request(self):
                         url='/example/{id}/',
                         action='get',
                         fields=[
-                            coreapi.Field('id', required=True, location='path', schema=coreschema.String())
+                            coreapi.Field('id', required=True, location='path', schema=coreschema.String()),
+                            coreapi.Field('ordering', required=False, location='query', schema=coreschema.String(title='Ordering', description='Which field to use when ordering the results.'))
                         ]
                     )
                 }
@@ -179,7 +180,8 @@ def test_authenticated_request(self):
                         url='/example/{id}/',
                         action='get',
                         fields=[
-                            coreapi.Field('id', required=True, location='path', schema=coreschema.String())
+                            coreapi.Field('id', required=True, location='path', schema=coreschema.String()),
+                            coreapi.Field('ordering', required=False, location='query', schema=coreschema.String(title='Ordering', description='Which field to use when ordering the results.'))
                         ]
                     ),
                     'custom_action': coreapi.Link(
@@ -225,7 +227,8 @@ def test_authenticated_request(self):
                         fields=[
                             coreapi.Field('id', required=True, location='path', schema=coreschema.String()),
                             coreapi.Field('a', required=True, location='form', schema=coreschema.String(title='A', description=('A field description'))),
-                            coreapi.Field('b', required=False, location='form', schema=coreschema.String(title='B'))
+                            coreapi.Field('b', required=False, location='form', schema=coreschema.String(title='B')),
+                            coreapi.Field('ordering', required=False, location='query', schema=coreschema.String(title='Ordering', description='Which field to use when ordering the results.'))
                         ]
                     ),
                     'partial_update': coreapi.Link(
@@ -235,14 +238,16 @@ def test_authenticated_request(self):
                         fields=[
                             coreapi.Field('id', required=True, location='path', schema=coreschema.String()),
                             coreapi.Field('a', required=False, location='form', schema=coreschema.String(title='A', description='A field description')),
-                            coreapi.Field('b', required=False, location='form', schema=coreschema.String(title='B'))
+                            coreapi.Field('b', required=False, location='form', schema=coreschema.String(title='B')),
+                            coreapi.Field('ordering', required=False, location='query', schema=coreschema.String(title='Ordering', description='Which field to use when ordering the results.'))
                         ]
                     ),
                     'delete': coreapi.Link(
                         url='/example/{id}/',
                         action='delete',
                         fields=[
-                            coreapi.Field('id', required=True, location='path', schema=coreschema.String())
+                            coreapi.Field('id', required=True, location='path', schema=coreschema.String()),
+                            coreapi.Field('ordering', required=False, location='query', schema=coreschema.String(title='Ordering', description='Which field to use when ordering the results.'))
                         ]
                     )
                 }
@@ -450,7 +455,8 @@ def test_schema_for_regular_views(self):
                         url='/example1/{id}/',
                         action='get',
                         fields=[
-                            coreapi.Field('id', required=True, location='path', schema=coreschema.String())
+                            coreapi.Field('id', required=True, location='path', schema=coreschema.String()),
+                            coreapi.Field('ordering', required=False, location='query', schema=coreschema.String(title='Ordering', description='Which field to use when ordering the results.'))
                         ]
                     )
                 }

Original file line number	Diff line number	Diff line change
`@@ -139,7 +139,8 @@ def test_anonymous_request(self):`
`139`	`139`	`url='/example/{id}/',`
`140`	`140`	`action='get',`
`141`	`141`	`fields=[`
`142`		`- coreapi.Field('id', required=True, location='path', schema=coreschema.String())`
	`142`	`+ coreapi.Field('id', required=True, location='path', schema=coreschema.String()),`
	`143`	`+ coreapi.Field('ordering', required=False, location='query', schema=coreschema.String(title='Ordering', description='Which field to use when ordering the results.'))`
`143`	`144`	`]`
`144`	`145`	`)`
`145`	`146`	`}`
`@@ -179,7 +180,8 @@ def test_authenticated_request(self):`
`179`	`180`	`url='/example/{id}/',`
`180`	`181`	`action='get',`
`181`	`182`	`fields=[`
`182`		`- coreapi.Field('id', required=True, location='path', schema=coreschema.String())`
	`183`	`+ coreapi.Field('id', required=True, location='path', schema=coreschema.String()),`
	`184`	`+ coreapi.Field('ordering', required=False, location='query', schema=coreschema.String(title='Ordering', description='Which field to use when ordering the results.'))`
`183`	`185`	`]`
`184`	`186`	`),`
`185`	`187`	`'custom_action': coreapi.Link(`
`@@ -225,7 +227,8 @@ def test_authenticated_request(self):`
`225`	`227`	`fields=[`
`226`	`228`	`coreapi.Field('id', required=True, location='path', schema=coreschema.String()),`
`227`	`229`	`coreapi.Field('a', required=True, location='form', schema=coreschema.String(title='A', description=('A field description'))),`
`228`		`- coreapi.Field('b', required=False, location='form', schema=coreschema.String(title='B'))`
	`230`	`+ coreapi.Field('b', required=False, location='form', schema=coreschema.String(title='B')),`
	`231`	`+ coreapi.Field('ordering', required=False, location='query', schema=coreschema.String(title='Ordering', description='Which field to use when ordering the results.'))`
`229`	`232`	`]`
`230`	`233`	`),`
`231`	`234`	`'partial_update': coreapi.Link(`
`@@ -235,14 +238,16 @@ def test_authenticated_request(self):`
`235`	`238`	`fields=[`
`236`	`239`	`coreapi.Field('id', required=True, location='path', schema=coreschema.String()),`
`237`	`240`	`coreapi.Field('a', required=False, location='form', schema=coreschema.String(title='A', description='A field description')),`
`238`		`- coreapi.Field('b', required=False, location='form', schema=coreschema.String(title='B'))`
	`241`	`+ coreapi.Field('b', required=False, location='form', schema=coreschema.String(title='B')),`
	`242`	`+ coreapi.Field('ordering', required=False, location='query', schema=coreschema.String(title='Ordering', description='Which field to use when ordering the results.'))`
`239`	`243`	`]`
`240`	`244`	`),`
`241`	`245`	`'delete': coreapi.Link(`
`242`	`246`	`url='/example/{id}/',`
`243`	`247`	`action='delete',`
`244`	`248`	`fields=[`
`245`		`- coreapi.Field('id', required=True, location='path', schema=coreschema.String())`
	`249`	`+ coreapi.Field('id', required=True, location='path', schema=coreschema.String()),`
	`250`	`+ coreapi.Field('ordering', required=False, location='query', schema=coreschema.String(title='Ordering', description='Which field to use when ordering the results.'))`
`246`	`251`	`]`
`247`	`252`	`)`
`248`	`253`	`}`
`@@ -450,7 +455,8 @@ def test_schema_for_regular_views(self):`
`450`	`455`	`url='/example1/{id}/',`
`451`	`456`	`action='get',`
`452`	`457`	`fields=[`
`453`		`- coreapi.Field('id', required=True, location='path', schema=coreschema.String())`
	`458`	`+ coreapi.Field('id', required=True, location='path', schema=coreschema.String()),`
	`459`	`+ coreapi.Field('ordering', required=False, location='query', schema=coreschema.String(title='Ordering', description='Which field to use when ordering the results.'))`
`454`	`460`	`]`
`455`	`461`	`)`
`456`	`462`	`}`