apidoco 1.5.1 → 1.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eaedb68c0b3c0855c32787e0c4c2a3d943022df15b7def1e4a91c0975e11e97b
-  data.tar.gz: 9285d5c75bd01f3c7ac1d67fb02ef2ae0d195523c2305620eb43a44622cf294a
+  metadata.gz: 2e3d3454ddc778794cd54370eaa81246d6fc10701f25cbb598b63d1c7660dbab
+  data.tar.gz: add5252b311eef0cb55987e1fd595fa3ffce9b14f19991bf5ceabc321405e99d
 SHA512:
-  metadata.gz: 36c137e04f691a6b82fcbed0872205ed2f50dc561a948c8e6a7ed0c9e0fd184931d718a1a7ec87d71ca58be13a6c71a3cd59e7be0dd5b9136beefe02bd630dc9
-  data.tar.gz: c3bef495bf6b949f4967356bfb30bc4502d837c00919fe5870dc6e32a16084147801eb135bd75a330e17cdcd5088eeb35600dcba8b0c00435b81c570dceec48c
+  metadata.gz: c1dbd0735e3bbef5d25a9be6bbfd4b9623e846c43854909b5caf6968c2cd63d12be6098739ec5a7287af26454c4d54894f5c856aab94dde6a571826ac7d13df2
+  data.tar.gz: 886772bcf39b54fdbdecf01506340ef80aaf3f003cda625ee39556d0b1b60bae3d9ee389edafa6429aaa2ef5067b5de9d1fcaba8e534db48cb1a38c12c6c92e7

data/README.md

@@ -35,6 +35,7 @@ Create a configuration file in initializers e.g. /config/initializers/apidoco.rb
 ```ruby
 Apidoco.auth_name = 'authentication_name'
 Apidoco.auth_password = 'authentication_password'
+Apidoco.app_name = 'your app name' # This will appear as the HTML title for api_doco pages
 ```
 
 ## Generators
@@ -101,6 +102,10 @@ will create the following files with sample content
     "Content-Type": "application/json"
   },
   "examples": [{
+    "request_headers": {
+      "Authentication": "Token token=<token>",
+      "Content-Type": "application/json"
+    },
     "request": {
       "post": {
         "title": "Ruby is awesome",
@@ -108,6 +113,9 @@ will create the following files with sample content
         "published": false
       }
     },
+    "response_headers": {
+      "Authentication": "Token token=<token>"
+    },
     "response": {
       "suceess": true,
       "message": "Successfully created"
@@ -147,6 +155,10 @@ will create the following files with sample content
     "Content-Type": "application/json"
   },
   "examples": [{
+    "request_headers": {
+      "Authentication": "Token token=<token>",
+      "Content-Type": "application/json"
+    },
     "request": {
       "post": {
         "title": "Ruby is awesome",
@@ -154,6 +166,9 @@ will create the following files with sample content
         "published": false
       }
     },
+    "response_headers": {
+      "Content-Type": "application/json"
+    },
     "response": {
       "suceess": true,
       "message": "Successfully updated"
@@ -176,6 +191,10 @@ will create the following files with sample content
     "Content-Type": "application/json"
   },
   "examples": [{
+    "request_headers": {
+      "Authentication": "Token token=<token>",
+      "Content-Type": "application/json"
+    },
     "response": {
       "suceess": true,
       "message": "Successfully destroyed"
@@ -196,7 +215,7 @@ will create the following files with sample content
 | `http_method` | The HTTP method of the API | --- | `"http_method": "GET"` |
 | `params` | Parameters to be used | --- | `"params: [{ "key": "post['name']", "required": true, "type": "String", "notes": ["Name or title of the post"], "validations": ["should be less than or equal to 150 characters"] }]"` |
 | `header` | headers to be used | --- | `"header: { "Authorization": "Token token=<token>", "Content-type": 'application/json' }"` |
-| `examples` | Array of sample requests and responses | --- | `[{ "request": { "post": { "name": "I was scared" } } }, "response": { "message": "Post was successfully created", "id": 101 } }]`
+| `examples` | Array of sample requests, responses and their headers | --- | `[{ "request_headers": { "Authorization": "Token token=<token>", "Content-type": 'application/json' }, "request": { "post": { "name": "I was scared" } } }, "response_headers": { "Content-type": 'application/json' }, "response": { "message": "Post was successfully created", "id": 101 } }]`
 
 
 ## License

data/app/assets/javascripts/apidoco/controllers/documentations_controller.js

@@ -9,6 +9,10 @@ angular.module('apiDocoApp')
     $window.location.href = version.path;
   };
 
+  $scope.versionAddress = function () {
+    return $window.location.href.split('#')[0];
+  };
+
   $scope.viewRaw = function(data) {
     var dataStingified = JSON.stringify(data, null, 2);
     var x = window.open();

data/app/assets/stylesheets/apidoco/custom.css

@@ -40,3 +40,23 @@ h3 {
   margin-top: 0;
 }
 
+.container-flex {
+  display: flex;
+  width: 100%;
+  position: relative;
+}
+
+.container-flex .description {
+  flex: 0 0 65%;
+}
+
+.container-flex .examples {
+  position: absolute;
+  left: 70%;
+  top: 0;
+  bottom: 0;
+  right: 0;
+  overflow: auto;
+}
+
+

data/app/assets/stylesheets/apidoco/helpers.css

@@ -11,7 +11,14 @@
   margin-top: 10px !important;
 }
 
+.mb-50 {
+  margin-bottom: 50px !important;
+}
+
 .padding-10 {
   padding: 10px !important;
 }
 
+.padding-15 {
+  padding: 15px !important;
+}

data/app/assets/stylesheets/apidoco/simple-sidebar.css

@@ -19,16 +19,16 @@
 }
 
 #wrapper.toggled {
-    padding-left: 275px;
+    padding-left: 225px;
 }
 
 #sidebar-wrapper {
     z-index: 1000;
     position: fixed;
-    left: 275px;
+    left: 225px;
     width: 0;
     height: 100%;
-    margin-left: -275px;
+    margin-left: -225px;
     overflow-y: auto;
     background: #364150;
     -webkit-transition: all 0.5s ease;
@@ -39,7 +39,7 @@
 }
 
 #wrapper.toggled #sidebar-wrapper {
-    width: 275px;
+    width: 225px;
 }
 
 #page-content-wrapper {
@@ -50,7 +50,7 @@
 
 #wrapper.toggled #page-content-wrapper {
     position: absolute;
-    margin-right: -275px;
+    margin-right: -225px;
 }
 
 /* Sidebar Styles */
@@ -105,7 +105,7 @@
 
 @media(min-width:768px) {
     #wrapper {
-        padding-left: 275px;
+        padding-left: 225px;
     }
 
     #wrapper.toggled {
@@ -113,7 +113,7 @@
     }
 
     #sidebar-wrapper {
-        width: 275px;
+        width: 225px;
     }
 
     #wrapper.toggled #sidebar-wrapper {

data/app/views/apidoco/apis/_examples.html

@@ -0,0 +1,70 @@
+<div class="section-block" ng-if="x.examples && x.examples.length > 0">
+  <h3 class="block-title">Examples</h5>
+  <div class="rows mb-50" ng-repeat="example in x.examples">
+    <table class="table table-bordered">
+      <!-- Request Headers -->
+      <tbody ng-if="example.request_headers">
+        <tr>
+          <th>Request Headers</th>
+        </tr>
+        <tr>
+          <td class="padding-15">
+            <div class="btn-group pull-right" role="group">
+              <button class="btn btn-default btn-sm" ng-click="viewRaw(example.request_headers)">Raw</button>
+              <button class="btn btn-default btn-sm" ngclipboard data-clipboard-text="{{example.request_headers}}">Copy</button>
+            </div>
+            <div jq-json-viewer data="example.request_headers"></div>
+          </td>
+        </tr>
+      </tbody>
+
+      <!-- Request -->
+      <tbody ng-if="example.request">
+        <tr>
+          <th>Request</th>
+        </tr>
+        <tr>
+          <td class="padding-15">
+            <div class="btn-group pull-right" role="group">
+            <button class="btn btn-default btn-sm" ng-click="viewRaw(example.request)">Raw</button>
+            <button class="btn btn-default btn-sm" ngclipboard data-clipboard-text="{{example.request}}">Copy</button>
+          </div>
+          <div jq-json-viewer data="example.request"></div>
+          </td>
+        </tr>
+      </tbody>
+
+      <!-- Response Headers -->
+      <tbody ng-if="example.response_headers">
+        <tr>
+          <th>Response Headers</th>
+        </tr>
+        <tr>
+          <td class="padding-15">
+            <div class="btn-group pull-right" role="group">
+            <button class="btn btn-default btn-sm" ng-click="viewRaw(example.response_headers)">Raw</button>
+            <button class="btn btn-default btn-sm" ngclipboard data-clipboard-text="{{example.response_headers}}">Copy</button>
+          </div>
+          <div jq-json-viewer data="example.response_headers"></div>
+          </td>
+        </tr>
+      </tbody>
+
+      <!-- Response -->
+      <tbody ng-if="example.response">
+        <tr>
+          <th>Response</th>
+        </tr>
+        <tr>
+          <td class="padding-15">
+            <div class="btn-group pull-right" role="group">
+            <button class="btn btn-default btn-sm" ng-click="viewRaw(example.response)">Raw</button>
+            <button class="btn btn-default btn-sm" ngclipboard data-clipboard-text="{{example.response}}">Copy</button>
+          </div>
+          <div jq-json-viewer data="example.response"></div>
+          </td>
+        </tr>
+      </tbody>
+    </table>
+  </div>
+</div>

data/app/views/apidoco/apis/_side_bar.html.erb

@@ -2,7 +2,7 @@
 <script type="text/ng-template" id="documentationTree">
   <a href="#{{documentation.id}}">{{documentation.name}}</a>
   <ul ng-if="documentation.children">
-    <li ng-repeat="documentation in documentation.children" ng-include="'documentationTree'">
+    <li ng-repeat="documentation in documentation.children | filter: searchKeyword" ng-include="'documentationTree'">
     </li>
   </ul>
 </script>

data/app/views/apidoco/apis/show.html.erb

@@ -30,129 +30,101 @@
               <ol class="breadcrumb">
                 <li ng-repeat="p in x.parents">{{p}}</li>
               </ol>
-              <h2 class="section-title">{{x.name}}</h4>
-
-              <p ng-if="x.description">{{x.description}}</p>
-
-              <div class="section-block">
-                <h3 class="block-title">Request</h5>
-                <div class="row">
-                  <div class="col-sm-8">
-                    <div class="input-group">
-                      <span class="input-group-btn">
-                        <button class="btn btn-success" type="button"><b>{{x.http_method}}</b></button>
-                      </span>
-                      <input type="text" readonly class="form-control" value="{{x.end_point}}">
+              <h2 class="section-title">{{x.name}}
+                <button class="btn btn-default btn-xs mt-1 pull-right" type="button" ngclipboard data-clipboard-text="{{versionAddress()}}#{{x.id}}">Copy permalink</button>
+              </h2>
+              <div class="container-flex">
+                <div class="description">
+                  <p ng-if="x.description">{{x.description}}</p>
+                  <div class="section-block">
+                    <h3 class="block-title">Request</h5>
+                    <div class="row">
+                      <div class="col-sm-8">
+                        <div class="input-group">
+                          <span class="input-group-btn">
+                            <button class="btn btn-success" type="button"><b>{{x.http_method}}</b></button>
+                          </span>
+                          <input type="text" readonly class="form-control" value="{{x.end_point}}">
+                        </div>
+                      </div>
+                      <div class="col-sm-4">
+                        <button class="btn btn-default btn-sm mt-2" type="button" ngclipboard data-clipboard-text="{{x.end_point}}">Copy</button>
+                      </div>
                     </div>
                   </div>
-                  <div class="col-sm-4">
-                    <button class="btn btn-default btn-sm mt-2" type="button" ngclipboard data-clipboard-text="{{x.end_point}}">Copy</button>
-                  </div>
-                </div>
-              </div>
-
-              <div class="section-block" ng-if="x.header">
-                <h3 class="block-title">Headers</h5>
-                <div class="table-responsive">
-                  <table class="table">
-                    <thead>
-                      <tr>
-                        <td>Name</td>
-                        <td>Description</td>
-                      </tr>
-                    </thead>
-                    <tbody>
-                      <tr ng-repeat="(key, value) in x.header">
-                        <td>
-                          <code>{{key}}</code>
-                        </td>
-                        <td>
-                          <code>{{value}}</code>
-                        </td>
-                      </tr>
-                    </tbody>
-                  </table>
-                </div>
-              </div>
-
-              <div class="section-block" ng-if="x.params && x.params.length > 0">
-                <h3 class="block-title">Parameters</h5>
-                <div class="table-responsive">
-                  <table class="table">
-                    <thead>
-                      <tr>
-                        <td>Parameter Name</td>
-                        <td></td>
-                        <td>Data Type</td>
-                        <td>Description</td>
-                        <td></td>
-                      </tr>
-                    </thead>
-                    <tbody>
-                      <tr ng-repeat="param in x.params">
-                        <td>
-                          <code>{{param.key}}</code>
-                        </td>
-                        <td>
-                          <button class="btn btn-xs btn-danger" ng-if="param.required">required</button>
-                          <button class="btn btn-xs btn-primary" ng-if="!param.required">optional</button>
-                        </td>
-                        <td>{{param.type}}</td>
-                        <td>{{param.description}}</td>
-                        <td>
-                          {{param.notes}}
-                          <p ng-if="param.validations">
-                            <b>Validations:</b><br>
-                            <span ng-repeat="validation in param.validations">{{validation}}<br></span>
-                          </p>
-                        </td>
-                      </tr>
-                    </tbody>
-                  </table>
-                </div>
-              </div>
 
-              <div class="section-block" ng-if="x.notes">
-                <h3 class="block-title">Notes</h5>
-                <p ng-repeat="note in x.notes">
-                  {{ note }}
-                </p>
-              </div>
-
-              <div class="section-block" ng-if="x.examples && x.examples.length > 0">
-                <h3 class="block-title">Examples</h5>
-                <div class="rows" ng-repeat="example in x.examples">
-                  <div class="col-sm-6" ng-if="example.request">
-                    <div class="panel panel-default">
-                      <div class="panel-heading">
-                        <h4 class="panel-title">Request</h4>
-                      </div>
-                      <div class="panel-body">
-                        <div class="btn-group pull-right" role="group">
-                          <button class="btn btn-default btn-sm" ng-click="viewRaw(example.request)">Raw</button>
-                          <button class="btn btn-default btn-sm" ngclipboard data-clipboard-text="{{example.request}}">Copy</button>
-                        </div>
-                        <div jq-json-viewer data="example.request"></div>
-                      </div>
+                  <div class="section-block" ng-if="x.header">
+                    <h3 class="block-title">Headers</h5>
+                    <div class="table-responsive">
+                      <table class="table">
+                        <thead>
+                          <tr>
+                            <td>Name</td>
+                            <td>Description</td>
+                          </tr>
+                        </thead>
+                        <tbody>
+                          <tr ng-repeat="(key, value) in x.header">
+                            <td>
+                              <code>{{key}}</code>
+                            </td>
+                            <td>
+                              <code>{{value}}</code>
+                            </td>
+                          </tr>
+                        </tbody>
+                      </table>
                     </div>
                   </div>
-                  <div class="col-sm-6" ng-if="example.response">
-                    <div class="panel panel-default">
-                      <div class="panel-heading">
-                        <h4 class="panel-title">Response</h4>
-                      </div>
-                      <div class="panel-body">
-                        <div class="btn-group pull-right" role="group">
-                          <button class="btn btn-default btn-sm" ng-click="viewRaw(example.response)">Raw</button>
-                          <button class="btn btn-default btn-sm" ngclipboard data-clipboard-text="{{example.response}}">Copy</button>
-                        </div>
-                        <div jq-json-viewer data="example.response"></div>
-                      </div>
+
+                  <div class="section-block" ng-if="x.params && x.params.length > 0">
+                    <h3 class="block-title">Parameters</h5>
+                    <div class="table-responsive">
+                      <table class="table">
+                        <thead>
+                          <tr>
+                            <td>Parameter Name</td>
+                            <td></td>
+                            <td>Data Type</td>
+                            <td>Description</td>
+                            <td></td>
+                          </tr>
+                        </thead>
+                        <tbody>
+                          <tr ng-repeat="param in x.params">
+                            <td>
+                              <code>{{param.key}}</code>
+                            </td>
+                            <td>
+                              <button class="btn btn-xs btn-danger" ng-if="param.required">required</button>
+                              <button class="btn btn-xs btn-primary" ng-if="!param.required">optional</button>
+                            </td>
+                            <td>{{param.type}}</td>
+                            <td>{{param.description}}</td>
+                            <td>
+                              {{param.notes}}
+                              <p ng-if="param.validations">
+                                <b>Validations:</b><br>
+                                <span ng-repeat="validation in param.validations">{{validation}}<br></span>
+                              </p>
+                            </td>
+                          </tr>
+                        </tbody>
+                      </table>
                     </div>
                   </div>
+
+                  <div class="section-block" ng-if="x.notes">
+                    <h3 class="block-title">Notes</h5>
+                    <p ng-repeat="note in x.notes">
+                      {{ note }}
+                    </p>
+                  </div>
+                </div>
+                <div class="examples">
+                  <%= render partial: "examples" %>
                 </div>
               </div>
-
             </div>
           </div>
         </div>