From 7e17e85edb626d210663e8e38f89436f66f7e4c0 Mon Sep 17 00:00:00 2001
From: Lee Lawlor <primemod3@gmail.com>
Date: Wed, 18 Jun 2014 12:31:58 -0400
Subject: [PATCH] update docs for API keys

---
 app/controllers/charts_controller.rb     | 2 +-
 app/views/docs/channels/_feed.html.erb   | 6 +++---
 app/views/docs/channels/_field.html.erb  | 4 ++--
 app/views/docs/channels/_status.html.erb | 2 +-
 app/views/docs/charts.html.erb           | 2 +-
 app/views/docs/index.html.erb            | 4 +++-
 6 files changed, 11 insertions(+), 9 deletions(-)

diff --git a/app/controllers/charts_controller.rb b/app/controllers/charts_controller.rb
index 4794a13..4bf7faf 100644
--- a/app/controllers/charts_controller.rb
+++ b/app/controllers/charts_controller.rb
@@ -38,7 +38,7 @@ class ChartsController < ApplicationController
   def show
 
     # allow these parameters when creating feed querystring
-    feed_params = ['key','days','start','end','round','timescale','average','median','sum','results','location','status']
+    feed_params = ['key', 'api_key', 'apikey', 'days','start','end','round','timescale','average','median','sum','results','location','status']
 
     # set chart size
     width = params[:width].present? ? params[:width] : Chart.default_width
diff --git a/app/views/docs/channels/_feed.html.erb b/app/views/docs/channels/_feed.html.erb
index a89ce2c..c45bf5c 100644
--- a/app/views/docs/channels/_feed.html.erb
+++ b/app/views/docs/channels/_feed.html.erb
@@ -10,7 +10,7 @@ replacing <span class="customcode">CHANNEL_ID</span> with the ID of your Channel
 <br><br>
 Valid parameters:
 <ul>
-  <li><b>key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
+  <li><b>api_key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
   <li><b>results</b> (integer) Number of entries to retrieve, 8000 max, default of 100 (optional)</li>
   <li><b>days</b> (integer) Number of 24-hour periods before now to include in feed (optional)</li>
   <li><b>start</b> (datetime) Start date in format YYYY-MM-DD%20HH:NN:SS (optional)</li>
@@ -176,7 +176,7 @@ replacing <span class="customcode">CHANNEL_ID</span> with the ID of your Channel
 <br><br>
 Valid parameters:
 <ul>
-  <li><b>key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
+  <li><b>api_key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
   <li><b>timezone</b> (string) <a href="/docs#timezones">Timezone identifier</a> for this request (optional)</li>
   <li><b>offset</b> (integer) Timezone offset that results should be displayed in. Please use the <a href="/docs#timezones">timezone</a> parameter for greater accuracy. (optional)</li>
   <li><b>status</b> (true/false) Include status updates in feed by setting "status=true" (optional)</li>
@@ -249,7 +249,7 @@ replacing <span class="customcode">CHANNEL_ID</span> with the ID of your Channel
 <br><br>
 Valid parameters:
 <ul>
-  <li><b>key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
+  <li><b>api_key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
   <li><b>timezone</b> (string) <a href="/docs#timezones">Timezone identifier</a> for this request (optional)</li>
   <li><b>offset</b> (integer) Timezone offset that results should be displayed in. Please use the <a href="/docs#timezones">timezone</a> parameter for greater accuracy. (optional)</li>
   <li><b>status</b> (true/false) Include status updates in feed by setting "status=true" (optional)</li>
diff --git a/app/views/docs/channels/_field.html.erb b/app/views/docs/channels/_field.html.erb
index 6a4f682..1262bad 100644
--- a/app/views/docs/channels/_field.html.erb
+++ b/app/views/docs/channels/_field.html.erb
@@ -10,7 +10,7 @@ replacing <span class="customcode">CHANNEL_ID</span> with the ID of your Channel
 <br><br>
 Valid parameters:
 <ul>
-  <li><b>key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
+  <li><b>api_key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
   <li><b>results</b> (integer) Number of entries to retrieve, 8000 max, default of 100 (optional)</li>
   <li><b>days</b> (integer) Number of 24-hour periods before now to include in feed (optional)</li>
   <li><b>start</b> (datetime) Start date in format YYYY-MM-DD%20HH:NN:SS (optional)</li>
@@ -160,7 +160,7 @@ replacing <span class="customcode">CHANNEL_ID</span> with the ID of your Channel
 <br><br>
 Valid parameters:
 <ul class="format-block">
-  <li><b>key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
+  <li><b>api_key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
   <li><b>timezone</b> (string) <a href="/docs#timezones">Timezone identifier</a> for this request (optional)</li>
   <li><b>offset</b> (integer) Timezone offset that results should be displayed in. Please use the <a href="/docs#timezones">timezone</a> parameter for greater accuracy. (optional)</li>
   <li><b>status</b> (true/false) Include status updates in feed by setting "status=true" (optional)</li>
diff --git a/app/views/docs/channels/_status.html.erb b/app/views/docs/channels/_status.html.erb
index fe2a701..d49fd3f 100644
--- a/app/views/docs/channels/_status.html.erb
+++ b/app/views/docs/channels/_status.html.erb
@@ -10,7 +10,7 @@ replacing <span class="customcode">CHANNEL_ID</span> with the ID of your Channel
 <br><br>
 Valid parameters:
 <ul>
-  <li><b>key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
+  <li><b>api_key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
   <li><b>timezone</b> (string) <a href="/docs#timezones">Timezone identifier</a> for this request (optional)</li>
   <li><b>offset</b> (integer) Timezone offset that results should be displayed in. Please use the <a href="/docs#timezones">timezone</a> parameter for greater accuracy. (optional)</li>
   <li><b>callback</b> (string) Function name to be used for JSONP cross-domain requests (optional)</li>
diff --git a/app/views/docs/charts.html.erb b/app/views/docs/charts.html.erb
index 9eea54f..d7f43de 100644
--- a/app/views/docs/charts.html.erb
+++ b/app/views/docs/charts.html.erb
@@ -40,7 +40,7 @@
     <br>
     Valid feed parameters:
     <ul>
-      <li><b>key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
+      <li><b>api_key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
       <li><b>results</b> (integer) Number of entries to retrieve, 8000 max, default of 100 (optional)</li>
       <li><b>days</b> (integer) Number of 24-hour periods before now to include in feed (optional)</li>
       <li><b>start</b> (datetime) Start date in format YYYY-MM-DD%20HH:NN:SS (optional)</li>
diff --git a/app/views/docs/index.html.erb b/app/views/docs/index.html.erb
index bc6d7a8..4d1459d 100644
--- a/app/views/docs/index.html.erb
+++ b/app/views/docs/index.html.erb
@@ -30,7 +30,9 @@
 
     <br><br>
     <h4 id="headers">HTTP Headers</h4>
-    If you would like to reduce the number of HTTP headers sent by our application, please add the parameter "headers=false" to any HTTP request.
+    If you would like to reduce the number of HTTP headers sent by our application, please add the parameter <code>headers=false</code> to any HTTP request.
+    <br><br>
+    API keys can optionally be sent via HTTP headers by setting the header name to <code><%= HTTP_HEADER_API_KEY_NAME %></code> and the header value to the API key.
 
     <br><br><br><br>
     <h4 id="timezones">Time Zones Reference</h4>