Merge pull request #563 from Logimeter/schema-description

Include filter fields' help text as coreapi descriptions
This commit is contained in:
Carlton Gibson 2016-11-17 09:26:40 +01:00 committed by GitHub
commit e7fa6989a3
1 changed files with 4 additions and 2 deletions

View File

@ -2,6 +2,7 @@
from __future__ import absolute_import
from django.template import Template, TemplateDoesNotExist, loader
from django.utils import six
from rest_framework.compat import template_render
from rest_framework.filters import BaseFilterBackend
@ -98,6 +99,7 @@ class DjangoFilterBackend(BaseFilterBackend):
filter_class = self.get_filter_class(view, view.get_queryset())
return [] if not filter_class else [
compat.coreapi.Field(name=field_name, required=False, location='query')
for field_name in filter_class().filters.keys()
compat.coreapi.Field(
name=field_name, required=False, location='query', description=six.text_type(field.field.help_text))
for field_name, field in filter_class().filters.items()
]