encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-08-02 11:30:12 +03:00
Code Issues Packages Projects Releases Wiki Activity

added ability to add sections to custom action documentation

Browse Source
This commit is contained in:
Dan Bate 2018-06-25 16:50:45 +01:00
parent 0e10d32fb1
commit 65a0d59c70
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
rest_framework/schemas/inspectors.py
View File

@ -233,9 +233,11 @@ class AutoSchema(ViewInspector):
method_docstring = getattr(view, method_name, None).__doc__ method_docstring = getattr(view, method_name, None).__doc__
if method_docstring: if method_docstring:
# An explicit docstring on the method or action. # An explicit docstring on the method or action.
return formatting.dedent(smart_text(method_docstring)) return self._get_description_section(view, method.lower(), formatting.dedent(smart_text(method_docstring)))
else:
return self._get_description_section(view, getattr(view, 'action', method.lower()), view.get_view_description())
description = view.get_view_description() def _get_description_section(self, view, header, description):
lines = [line for line in description.splitlines()] lines = [line for line in description.splitlines()]
current_section = '' current_section = ''
sections = {'': ''} sections = {'': ''}
@ -249,7 +251,6 @@ class AutoSchema(ViewInspector):
# TODO: SCHEMA_COERCE_METHOD_NAMES appears here and in `SchemaGenerator.get_keys` # TODO: SCHEMA_COERCE_METHOD_NAMES appears here and in `SchemaGenerator.get_keys`
coerce_method_names = api_settings.SCHEMA_COERCE_METHOD_NAMES coerce_method_names = api_settings.SCHEMA_COERCE_METHOD_NAMES
header = getattr(view, 'action', method.lower())
if header in sections: if header in sections:
return sections[header].strip() return sections[header].strip()
if header in coerce_method_names: if header in coerce_method_names: