Rename URL parameter

Author: Emmanouil Konstantinidis

rest_framework_docs/api_docs.py

@@ -7,28 +7,33 @@
 
 class ApiDocumentation(object):
 
- def __init__(self, filter_param=None):
+ def __init__(self, parent_app=None):
  """
- :param filter_param: namespace or app_name
+ parent_app: namespace or app_name
  """
+
+ self.parent_app = parent_app
  self.endpoints = []
  root_urlconf = __import__(settings.ROOT_URLCONF)
  if hasattr(root_urlconf, 'urls'):
- self.get_all_view_names(root_urlconf.urls.urlpatterns, filter_param=filter_param)
+ self.get_all_view_names(root_urlconf.urls.urlpatterns)
  else:
- self.get_all_view_names(root_urlconf.urlpatterns, filter_param=filter_param)
+ self.get_all_view_names(root_urlconf.urlpatterns)
 
- def get_all_view_names(self, urlpatterns, parent_pattern=None, filter_param=None):
+ def get_all_view_names(self, urlpatterns, parent_pattern=None):
  for pattern in urlpatterns:
- if isinstance(pattern, RegexURLResolver) and (not filter_param or filter_param in [pattern.app_name, pattern.namespace]):
- self.get_all_view_names(urlpatterns=pattern.url_patterns, parent_pattern=pattern, filter_param=filter_param)
+ if isinstance(pattern, RegexURLResolver) and (self.parent_app in [pattern.app_name, pattern.namespace]):
+ self.get_all_view_names(urlpatterns=pattern.url_patterns, parent_pattern=pattern)
+
  elif isinstance(pattern, RegexURLPattern) and self._is_drf_view(pattern):
- if not filter_param or (parent_pattern and filter_param in [parent_pattern.app_name, parent_pattern.namespace]):
+ if not self.parent_app or (parent_pattern and self.parent_app in [parent_pattern.app_name, parent_pattern.namespace]):
  api_endpoint = ApiEndpoint(pattern, parent_pattern)
  self.endpoints.append(api_endpoint)
 
  def _is_drf_view(self, pattern):
- # Should check whether a pattern inherits from DRF's APIView
+ """
+ Should check whether a pattern inherits from DRF's APIView
+ """
  return hasattr(pattern.callback, 'cls') and issubclass(pattern.callback.cls, APIView)
 
  def get_endpoints(self):

rest_framework_docs/api_endpoint.py

@@ -10,6 +10,7 @@ def __init__(self, pattern, parent_pattern=None):
  self.pattern = pattern
  self.callback = pattern.callback
  self.docstring = self.__get_docstring__()
+
  if parent_pattern:
  self.name_parent = parent_pattern.namespace or parent_pattern.app_name or \
  simplify_regex(parent_pattern.regex.pattern).replace('/', '-')
@@ -19,7 +20,7 @@ def __init__(self, pattern, parent_pattern=None):
  else:
  self.name_parent = ''
  self.name = ''
- # self.labels = (self.name_parent, self.name, slugify(self.name))
+
  self.labels = dict(parent=self.name_parent, name=self.name)
  self.path = self.__get_path__(parent_pattern)
  self.allowed_methods = self.__get_allowed_methods__()

rest_framework_docs/urls.py

@@ -4,6 +4,7 @@
 urlpatterns = [
  # Url to view the API Docs
  url(r'^$', DRFDocsView.as_view(), name='drfdocs'),
+
  # Url to view the API Docs with a specific namespace or app_name
- url(r'^(?P<filter_param>[\w-]+)/$', DRFDocsView.as_view(), name='drfdocs-filter'),
+ url(r'^(?P<parent_app>[\w-]+)/$', DRFDocsView.as_view(), name='drfdocs-filter'),
 ]

rest_framework_docs/views.py

@@ -11,16 +11,16 @@ class DRFDocsView(TemplateView):
  def get_context_data(self, **kwargs):
  settings = DRFSettings().settings
  search_query = self.request.GET.get("search", "")
- filter_param = self.kwargs.get("filter_param", None)
+ parent_app = self.kwargs.get("parent_app", None)
 
  if settings["HIDE_DOCS"]:
  raise Http404("Django Rest Framework Docs are hidden. Check your settings.")
 
- docs = ApiDocumentation(filter_param=filter_param)
+ docs = ApiDocumentation(parent_app=parent_app)
  endpoints = docs.get_endpoints()
 
- if filter_param and not endpoints:
- raise Http404("The are no endpoints for \"%s\"." % filter_param)
+ if parent_app and not endpoints:
+ raise Http404("The are no endpoints for \"%s\"." % parent_app)
 
  if search_query and endpoints:
  endpoints = [endpoint for endpoint in endpoints if search_query in endpoint.path]