added some annotated screenshots for API Console section

HerveCaumont · Apr 26, 2016 · f3bce71 · f3bce71
1 parent c649a1d
commit f3bce71
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 0 deletions.
diff --git a/source/images/API-Console-execute-query.png b/source/images/API-Console-execute-query.png
diff --git a/source/images/API-Console-preview.png b/source/images/API-Console-preview.png
diff --git a/source/images/API-Console-results.png b/source/images/API-Console-results.png
diff --git a/source/includes/_rest-api.md b/source/includes/_rest-api.md
@@ -541,6 +541,16 @@ request(options, function (error, response, body) {
     </tbody>
 </table>
 
+## API Console
+[API Console](http://api.planetos.com/console/) provides simple UI for building API query interactively.
+It has short descriptions of query parameters and output JSON schema.
+If the user enters his personal API key into an appropriate query field, API Console allows to execute that query and see results.
+
+<a href="images/API-Console-preview.png" data-featherlight><img src="images/API-Console-preview.png" alt="API Console"/></a>
+
+<a href="images/API-Console-execute-query.png" data-featherlight><img src="images/API-Console-execute-query.png" alt="API Console"/></a>
+
+<a href="images/API-Console-results.png" data-featherlight><img src="images/API-Console-results.png" alt="API Console"/></a>
 
 ## Rate Limits
 The REST API is rate limited to **500 calls per day**.

diff --git a/source/javascripts/lib/featherlight.js b/source/javascripts/lib/featherlight.js
diff --git a/source/layouts/layout.erb b/source/layouts/layout.erb
@@ -26,6 +26,7 @@ under the License.
       <%= Rouge::Themes::Base16::Monokai.render(:scope => '.highlight') %>
     </style>
     <%= stylesheet_link_tag :screen, media: :screen %>
+    <%= stylesheet_link_tag :featherlight, media: :screen %>
     <%= stylesheet_link_tag :custom, media: :screen %>
     <%= stylesheet_link_tag :print, media: :print %>
     <% if current_page.data.search %>
@@ -35,6 +36,7 @@ under the License.
     <% end %>
 
     <%= javascript_include_tag  "apikey" %>
+    <%= javascript_include_tag  "lib/featherlight" %>
 
   </head>
 

diff --git a/source/stylesheets/featherlight.css b/source/stylesheets/featherlight.css