Merge pull request #377 from hadrienk/feature/display-api-description

Display the root description of the API

Author: jisoldi

dist/scripts/api-console.js

@@ -1245,6 +1245,7 @@
       $scope.disableThemeSwitcher       = $attrs.hasOwnProperty('disableThemeSwitcher');
       $scope.disableTitle               = $attrs.hasOwnProperty('disableTitle');
       $scope.disableTryIt               = $attrs.hasOwnProperty('disableTryIt');
+      $scope.disableDescription         = $attrs.hasOwnProperty('disableDescription');
       $scope.documentationCollapsed     = $attrs.hasOwnProperty('documentationCollapsed');
       $scope.proxy                      = $window.RAML.Settings.proxy;
       $scope.readResourceTraits         = readResourceTraits;
@@ -7162,6 +7163,8 @@ angular.module('ramlConsoleApp').run(['$templateCache', function($templateCache)
     "\n" +
     "  <h1 ng-if=\"!disableTitle\" class=\"raml-console-title\">{{raml.title}}</h1>\n" +
     "\n" +
+    "  <div ng-if=\"!disableDescription\" markdown=\"raml.description\"></div>\n" +
+    "\n" +
     "  <root-documentation></root-documentation>\n" +
     "\n" +
     "  <root-types types=\"types\" ng-if=\"types\"></root-types>\n" +

src/app/directives/raml-console.js

@@ -25,6 +25,8 @@
       $scope.disableThemeSwitcher       = $attrs.hasOwnProperty('disableThemeSwitcher');
       $scope.disableTitle               = $attrs.hasOwnProperty('disableTitle');
       $scope.disableTryIt               = $attrs.hasOwnProperty('disableTryIt');
+      $scope.disableDescription         = $attrs.hasOwnProperty('disableDescription');
+      $scope.descriptionLimit           = $attrs.hasOwnProperty('descriptionLimit') || 300;
       $scope.documentationCollapsed     = $attrs.hasOwnProperty('documentationCollapsed');
       $scope.proxy                      = $window.RAML.Settings.proxy;
       $scope.readResourceTraits         = readResourceTraits;

src/app/directives/raml-console.tpl.html

@@ -6,6 +6,15 @@
 
   <h1 ng-if="!disableTitle" class="raml-console-title">{{raml.title}}</h1>
 
+
+  <div ng-if="!disableDescription" ng-init="actualSize = descriptionLimit" >
+    <div markdown="raml.description | limitTo : actualSize"></div>
+    <span>
+      <a ng-click="actualSize = descriptionLimit" ng-hide="raml.description.length > actualSize || raml.description.length < actualSize" style="cursor: default;">show less</a>
+      <a ng-click="actualSize = raml.description.length" ng-hide="raml.description.length == actualSize" style="cursor: default;">show more</a>
+    </span>
+  </div>
+
   <root-documentation></root-documentation>
 
   <root-types types="types" ng-if="types"></root-types>