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

Support for ModelViewSet #74

Merged
merged 6 commits into from
Jan 25, 2017
Merged

Support for ModelViewSet #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
225c47b
Support Model View Sets
Jan 21, 2016
35d2f0a
Merge branch 'master' into support-viewsets
Mar 22, 2016
45bc110
Merge branch 'master' into support-viewsets
Brobin Apr 8, 2016
f44ccba
fix broken test by sorting both lists
Brobin Apr 8, 2016
82421e5
Merge pull request #83 from Brobin/support-viewsets
ekonstantinidis Apr 12, 2016
3e64e0f
Merge branch 'master' into support-viewsets
ekonstantinidis May 25, 2016
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
14 changes: 13 additions & 1 deletion rest_framework_docs/api_endpoint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
import inspect
from django.contrib.admindocs.views import simplify_regex
from django.utils.encoding import force_str
from rest_framework.viewsets import ModelViewSet

VIEWSET_METHODS = {
'List': ['get', 'post'],
'Instance': ['get', 'put', 'patch', 'delete'],
}


class ApiEndpoint(object):
Expand All @@ -25,8 +31,14 @@ def __get_path__(self, parent_pattern):
return "/{0}{1}".format(self.name_parent, simplify_regex(self.pattern.regex.pattern))
return simplify_regex(self.pattern.regex.pattern)

def is_method_allowed(self, method_name, callback_cls):
return hasattr(callback_cls, method_name) or (
issubclass(callback_cls, ModelViewSet) and method_name in VIEWSET_METHODS.get(self.callback.suffix, [])
)

def __get_allowed_methods__(self):
return [force_str(m).upper() for m in self.callback.cls.http_method_names if hasattr(self.callback.cls, m)]
callback_cls = self.callback.cls
return sorted([force_str(name).upper() for name in callback_cls.http_method_names if self.is_method_allowed(name, callback_cls)])

def __get_docstring__(self):
return inspect.getdoc(self.callback)
Expand Down
2 changes: 1 addition & 1 deletion tests/tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ def test_index_view_with_endpoints(self):

# Test the login view
self.assertEqual(response.context["endpoints"][0].name_parent, "accounts")
self.assertEqual(response.context["endpoints"][0].allowed_methods, ['POST', 'OPTIONS'])
self.assertEqual(sorted(response.context["endpoints"][0].allowed_methods), sorted(['OPTIONS', 'POST']))
self.assertEqual(response.context["endpoints"][0].path, "/accounts/login/")
self.assertEqual(response.context["endpoints"][0].docstring, "A view that allows users to login providing their username and password.")
self.assertEqual(len(response.context["endpoints"][0].fields), 2)
Expand Down