Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/action docs sections #6060

Merged
merged 5 commits into from
Oct 10, 2018
Merged

Feature/action docs sections #6060

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
65a0d59
added ability to add sections to custom action documentation
OmegaDroid Jun 25, 2018
a138cfc
added tests to cover docs sections in custom actions
OmegaDroid Jun 26, 2018
c9ca4e9
Merge remote-tracking branch 'upsteam/master' into feature/action-doc…
OmegaDroid Sep 13, 2018
3893d7c
added method specific docs test for action mapping
OmegaDroid Sep 13, 2018
863f9e0
added docs for custom action documentation
OmegaDroid Oct 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions rest_framework/schemas/inspectors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,9 +233,11 @@ def get_description(self, path, method):
method_docstring = getattr(view, method_name, None).__doc__
if method_docstring:
# 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()]
current_section = ''
sections = {'': ''}
Expand All @@ -249,7 +251,6 @@ def get_description(self, path, method):

# TODO: SCHEMA_COERCE_METHOD_NAMES appears here and in `SchemaGenerator.get_keys`
coerce_method_names = api_settings.SCHEMA_COERCE_METHOD_NAMES
header = getattr(view, 'action', method.lower())
if header in sections:
return sections[header].strip()
if header in coerce_method_names:
Expand Down
42 changes: 42 additions & 0 deletions tests/test_schemas.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,17 @@ def get_serializer(self, *args, **kwargs):
assert self.action
return super(ExampleViewSet, self).get_serializer(*args, **kwargs)

@action(methods=['get', 'post'], detail=False)
def documented_custom_action(self, request):
"""
get:
A description of the get method on the custom action.

post:
A description of the post method on the custom action.
"""
pass


if coreapi:
schema_view = get_schema_view(title='Example API')
Expand Down Expand Up @@ -150,6 +161,13 @@ def test_anonymous_request(self):
action='get'
)
},
'documented_custom_action': {
'read': coreapi.Link(
url='/example/documented_custom_action/',
action='get',
description='A description of the get method on the custom action.',
)
},
'read': coreapi.Link(
url='/example/{id}/',
action='get',
Expand Down Expand Up @@ -245,6 +263,23 @@ def test_authenticated_request(self):
action='post'
)
},
'documented_custom_action': {
'read': coreapi.Link(
url='/example/documented_custom_action/',
action='get',
description='A description of the get method on the custom action.',
),
'create': coreapi.Link(
url='/example/documented_custom_action/',
action='post',
description='A description of the post method on the custom action.',
encoding='application/json',
fields=[
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'))
]
)
},
'update': coreapi.Link(
url='/example/{id}/',
action='put',
Expand Down Expand Up @@ -529,6 +564,13 @@ def test_schema_for_regular_views(self):
action='get'
)
},
'documented_custom_action': {
'read': coreapi.Link(
url='/example1/documented_custom_action/',
action='get',
description='A description of the get method on the custom action.',
),
},
'read': coreapi.Link(
url='/example1/{id}/',
action='get',
Expand Down