Hide Headers if "AllowAny" or "None"

Author: Emmanouil Konstantinidis

rest_framework_docs/api_endpoint.py

@@ -17,6 +17,7 @@ def __init__(self, pattern, parent_pattern=None):
         self.errors = None
         self.fields = self.__get_serializer_fields__()
         self.fields_json = self.__get_serializer_fields_json__()
+        self.permissions = self.__get_permissions_class__()
 
     def __get_path__(self, parent_pattern):
         if parent_pattern:
@@ -29,6 +30,10 @@ def __get_allowed_methods__(self):
     def __get_docstring__(self):
         return inspect.getdoc(self.callback)
 
+    def __get_permissions_class__(self):
+        for perm_class in self.pattern.callback.cls.permission_classes:
+            return perm_class.__name__
+
     def __get_serializer_fields__(self):
         fields = []
 

rest_framework_docs/static/rest_framework_docs/js/index.js

@@ -119,6 +119,15 @@ $( document ).ready(function() {
     });
   };
 
+  var _setupAuthorization = function (permissions) {
+
+    console.log(permissions);
+    if (permissions === 'None' || permissions === 'AllowAny') {
+      console.log('EMPTYYYY');
+      $('#headers').empty();
+    }
+  };
+
   var _setupFields = function (fields) {
     $.each( fields, function( i, field ) {
       var label = field.name.replace('_', ' ');
@@ -140,6 +149,7 @@ $( document ).ready(function() {
     $('#urlInput').val(data.path);
 
     _setupMethods(data.methods);
+    _setupAuthorization(data.permissions);
     _setupFields(data.fields);
 
     $('#requestForm').submit(function (e) {

rest_framework_docs/templates/rest_framework_docs/home.html

@@ -45,6 +45,7 @@ <h4 class="panel-title title">
                     data-toggle="modal"
                     data-path="{{ endpoint.path }}"
                     data-methods="{{ endpoint.allowed_methods }}"
+                    data-permissions="{{ endpoint.permissions }}"
                     data-fields="{{ endpoint.fields_json }}">
                     <i class="fa fa-plug"></i></li>
               </ul>
@@ -92,7 +93,7 @@ <h2 class="text-center">No endpoints found for {{ query }}.</h2>
       <div class="modal-content">
         <div class="modal-header">
           <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
-          <h4 class="modal-title">Live API Endpoints</h4>
+          <h4 class="modal-title">Live API Endpoints <span class="label label-info">Beta</span></h4>
         </div>
         <div class="modal-body">
 
@@ -110,11 +111,13 @@ <h3>Request</h3>
                 <h5 class="section-title"><span>Method</span></h5>
                 <div class="btn-group methods" id="methods" role="group"></div>
 
-                <h5 class="section-title"><span>Headers</span></h5>
-                <div class="form-group">
-                  <label for="exampleInputPassword1" class="col-sm-4 control-label">Authorization</label>
-                  <div class="col-sm-8">
-                    <input type="text" class="form-control input-sm" id="exampleInputPassword1" placeholder="Token">
+                <div id="headers">
+                  <h5 class="section-title"><span>Headers</span></h5>
+                  <div class="form-group">
+                    <label for="authorization" class="col-sm-4 control-label">Authorization</label>
+                    <div class="col-sm-8">
+                      <input type="text" class="form-control input-sm" id="authorization" placeholder="Token">
+                    </div>
                   </div>
                 </div>