From 225c47beede0bb0dff5a64cca0e14477537491e3 Mon Sep 17 00:00:00 2001 From: Maxence Date: Thu, 21 Jan 2016 09:55:37 +0100 Subject: [PATCH 1/2] Support Model View Sets --- rest_framework_docs/api_endpoint.py | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/rest_framework_docs/api_endpoint.py b/rest_framework_docs/api_endpoint.py index f37155c..d991d2b 100644 --- a/rest_framework_docs/api_endpoint.py +++ b/rest_framework_docs/api_endpoint.py @@ -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): @@ -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) From f44ccbae43a9b1614b0c61f164175ae2fa6748eb Mon Sep 17 00:00:00 2001 From: Brobin Date: Fri, 8 Apr 2016 14:50:26 -0500 Subject: [PATCH 2/2] fix broken test by sorting both lists --- tests/tests.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/tests.py b/tests/tests.py index afb58d0..c1978ec 100644 --- a/tests/tests.py +++ b/tests/tests.py @@ -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)