update plugins to allow listing via API
This commit is contained in:
Lee Lawlor
@ -46,7 +46,14 @@
|
||||
<li><a href="/docs/users">Users</a></li>
|
||||
<% end %>
|
||||
|
||||
<li class="<%= 'active' if params[:action] == 'plugins' %>"><a href="/docs/plugins">Plugins</a></li>
|
||||
<% if params[:action] == 'plugins' %>
|
||||
<li><a href="#plugins">Plugins</a></li>
|
||||
<li class="subitem"><a href="#example">Example</a></li>
|
||||
<li class="subitem"><a href="#index">List Plugins</a></li>
|
||||
<% else %>
|
||||
<li><a href="/docs/plugins">Plugins</a></li>
|
||||
<% end %>
|
||||
|
||||
<li class="<%= 'active' if params[:action] == 'tutorials' %>"><a href="/docs/tutorials">Tutorials</a></li>
|
||||
<li class="<%= 'active' if params[:action] == 'errors' %>"><a href="/docs/errors">Error Codes</a></li>
|
||||
</ul>
|
||||
|
||||
@ -12,14 +12,16 @@
|
||||
<br><br>
|
||||
|
||||
<hr />
|
||||
<h2>Example Plugin</h2>
|
||||
<h2 id="example">Example Plugin</h2>
|
||||
<p><a title="Display a Google Gauge Visualization using ThingSpeak Plugins" href="http://community.thingspeak.com/tutorials/google/display-a-google-gauge-visualization-using-thingspeak-plugins/">Display a Google Gauge Visualization using ThingSpeak Plugins</a> [<a title="Source ode for Google Gauge ThingSpeak Plugin" href="http://community.thingspeak.com/code/Google_Gauge.html">Source Code</a>]</p>
|
||||
|
||||
<p style="text-align: center;">
|
||||
<iframe width="100%" height="120" marginwidth="0" marginheight="0" scrolling="auto" frameborder="0" src="http://community.thingspeak.com/code/Google_Gauge.html"></iframe>
|
||||
</p>
|
||||
<br><br>
|
||||
|
||||
<br><br><br><br><br><br><br><br><br><br><br><br>
|
||||
<hr />
|
||||
<%= render 'docs/plugins/index' %>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
182
app/views/docs/plugins/_index.html.erb
Normal file
182
app/views/docs/plugins/_index.html.erb
Normal file
@ -0,0 +1,182 @@
|
||||
<div>
|
||||
<%= render 'response' %>
|
||||
<h2 id="index">List Public Plugins</h2>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
To view a list of public plugins, send an HTTP GET to
|
||||
<br>
|
||||
<code><%= @ssl_api_domain %>plugins/public<span class="format format-json">.json</span><span class="format format-xml">.xml</span></code> .
|
||||
|
||||
<br><br>
|
||||
Valid parameters:
|
||||
<ul>
|
||||
<li><b>page</b> (integer) Page number to retrieve (optional)</li>
|
||||
</ul>
|
||||
|
||||
<br>
|
||||
Example GET:
|
||||
|
||||
<pre>GET <span class="str"><%= @ssl_api_domain %>plugins/public<span class="format format-json">.json</span><span class="format format-xml">.xml</span></span></pre>
|
||||
|
||||
<br>
|
||||
|
||||
<div class="format format-block-xxl format-text">
|
||||
The response will be a webpage with a <a href="/plugins/public">list of public plugins</a>.
|
||||
</div>
|
||||
|
||||
<div class="format format-block-xxl format-json">
|
||||
The response will be a JSON object of public plugins, for example:
|
||||
|
||||
<pre class="prettyprint">
|
||||
{
|
||||
"pagination":
|
||||
{
|
||||
"current_page": 1,
|
||||
"per_page":15,
|
||||
"total_entries": 2
|
||||
},
|
||||
"plugins":
|
||||
[
|
||||
{
|
||||
"id": 8,
|
||||
"name": "google gauge",
|
||||
"created_at": "2014-01-05T16:35:26-05:00",
|
||||
"public_flag": true,
|
||||
"username": "hans",
|
||||
"url": "https://thingspeak.com/plugins/8"
|
||||
},
|
||||
{
|
||||
"id": 13,
|
||||
"name": "Plugin 13",
|
||||
"created_at": "2014-10-09T14:45:31-04:00",
|
||||
"public_flag": true,
|
||||
"username": "hans",
|
||||
"url": "https://thingspeak.com/plugins/13"
|
||||
}
|
||||
]
|
||||
}
|
||||
</pre>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="format format-block-xxl format-xml">
|
||||
The response will be an XML object of public plugins, for example:
|
||||
|
||||
<pre class="prettyprint">
|
||||
<response>
|
||||
<pagination>
|
||||
<current-page type="WillPaginate::PageNumber">1</current-page>
|
||||
<per-page type="integer">15</per-page>
|
||||
<total-entries type="integer">2</total-entries>
|
||||
</pagination>
|
||||
<plugins type="array">
|
||||
<plugin>
|
||||
<id type="integer">8</id>
|
||||
<name>google gauge</name>
|
||||
<created-at type="dateTime">2014-01-05T16:35:26-05:00</created-at>
|
||||
<public-flag type="boolean">true</public-flag>
|
||||
<username>hans</username>
|
||||
<url>https://thingspeak.com/plugins/8</url>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<id type="integer">13</id>
|
||||
<name>Plugin 13</name>
|
||||
<created-at type="dateTime">2014-10-09T14:45:31-04:00</created-at>
|
||||
<public-flag type="boolean">true</public-flag>
|
||||
<username>hans</username>
|
||||
<url>https://thingspeak.com/plugins/13</url>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</response>
|
||||
</pre>
|
||||
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<%= render 'response' %>
|
||||
<h2>List My Plugins</h2>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
To view a list of your plugins, send an HTTP GET to
|
||||
<br>
|
||||
<code><%= @ssl_api_domain %>plugins<span class="format format-json">.json</span><span class="format format-xml">.xml</span></code> .
|
||||
|
||||
<br><br>
|
||||
Valid parameters:
|
||||
<ul>
|
||||
<li><b>api_key</b> (string) - Your Account API Key, which can be found in your Account settings. (required)</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<br>
|
||||
Example GET:
|
||||
|
||||
<pre>GET <span class="str"><%= @ssl_api_domain %>plugins<span class="format format-json">.json</span><span class="format format-xml">.xml</span></span></pre>
|
||||
|
||||
<br>
|
||||
|
||||
<div class="format format-block-xxl format-text">
|
||||
The response will be a webpage with a <a href="/plugins">list of your plugins</a>.
|
||||
</div>
|
||||
|
||||
<div class="format format-block-xxl format-json">
|
||||
The response will be a JSON object of your plugins, for example:
|
||||
|
||||
<pre class="prettyprint">
|
||||
[
|
||||
{
|
||||
"id": 8,
|
||||
"name": "google gauge",
|
||||
"created_at": "2014-01-05T16:35:26-05:00",
|
||||
"public_flag": false,
|
||||
"username": "hans",
|
||||
"url": "https://thingspeak.com/plugins/8"
|
||||
},
|
||||
{
|
||||
"id": 13,
|
||||
"name": "Plugin 13",
|
||||
"created_at": "2014-10-09T14:45:31-04:00",
|
||||
"public_flag": false,
|
||||
"username": "hans",
|
||||
"url": "https://thingspeak.com/plugins/13"
|
||||
}
|
||||
]
|
||||
</pre>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="format format-block-xxl format-xml">
|
||||
The response will be an XML object of your plugins, for example:
|
||||
|
||||
<pre class="prettyprint">
|
||||
<response>
|
||||
<pagination>
|
||||
<current-page type="WillPaginate::PageNumber">1</current-page>
|
||||
<per-page type="integer">15</per-page>
|
||||
<total-entries type="integer">2</total-entries>
|
||||
</pagination>
|
||||
<plugins type="array">
|
||||
<plugin>
|
||||
<id type="integer">8</id>
|
||||
<name>google gauge</name>
|
||||
<created-at type="dateTime">2014-01-05T16:35:26-05:00</created-at>
|
||||
<public-flag type="boolean">false</public-flag>
|
||||
<username>hans</username>
|
||||
<url>https://thingspeak.com/plugins/8</url>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<id type="integer">13</id>
|
||||
<name>Plugin 13</name>
|
||||
<created-at type="dateTime">2014-10-09T14:45:31-04:00</created-at>
|
||||
<public-flag type="boolean">false</public-flag>
|
||||
<username>hans</username>
|
||||
<url>https://thingspeak.com/plugins/13</url>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</response>
|
||||
</pre>
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user