Skip to content

Commit

Permalink
add missing links to api docs (#136)
Browse files Browse the repository at this point in the history
* add missing links to api docs

* add speed_percent to api doc
  • Loading branch information
edaniszewski committed Apr 13, 2018
1 parent 6f421a3 commit 5fdc2aa
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 20 deletions.
20 changes: 10 additions & 10 deletions docs/api/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,16 +220,18 @@ is running with. The Synse Server configuration is made up of default, file, env
configuration components. This endpoint provides the final joined configuration that Synse Server
ultimately runs with.

For more information on how to configure Synse Server, see the user [documentation](). (TODO)
See the [Configuration Documentation](http://synse-server.readthedocs.io/en/latest/user/configuration.html)
for more information.

### HTTP Request

`GET http://host:5000/synse/2.0/config`

### Response

The response to the `config` endpoint is the unified configuration for Synse Server. See the
[documentation]() for more info on what the configuration scheme looks like.
The response to the `config` endpoint is the unified configuration for Synse Server. The
[Configuration Documentation](http://synse-server.readthedocs.io/en/latest/user/configuration.html)
describes the configuration scheme in more detail.



Expand Down Expand Up @@ -261,8 +263,8 @@ Get all the plugins that are currently registered with Synse Server.

This endpoint is added as a convenience to make it easier to determine which plugins Synse Server
is running with. Plugins can be registers with Synse Server in a variety of ways, including
file and environment configurations. See the [documentation]() for more on how to register plugins
with Synse Server. This endpoint shows the unified view of all registered plugins.
file and environment configurations. See the [User Guide](http://synse-server.readthedocs.io/en/latest/index.html)
for more on how to register plugins with Synse Server. This endpoint shows the unified view of all registered plugins.

### HTTP Request

Expand Down Expand Up @@ -638,7 +640,8 @@ Check the state and status of a write transaction.

If no transaction ID is given, a list of all cached transaction IDs is returned. The length
of time that a transaction is cached for is configurable. See the Synse Server configuration
[documentation]() for more.
[Configuration Documentation](http://synse-server.readthedocs.io/en/latest/user/configuration.html)
for more.

### HTTP Request

Expand Down Expand Up @@ -1014,10 +1017,7 @@ of valid query parameters are specified, the endpoint will write to the specifie
| Parameter | Description |
| --------- | ----------- |
| *speed* | The speed (in RPM) to set the fan to. |

<aside class="notice">
In the future, the fan route will support <i>rpm</i> and <i>percent</i> parameters for setting fan speed.
</aside>
| *speed_percent* | The speed (in percent) to set the fan to. |

<aside class="warning">
While Synse Server supports the listed Query Parameters, not all devices will support the
Expand Down
23 changes: 13 additions & 10 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -533,12 +533,14 @@ <h2 id='config'>Config</h2><pre class="highlight shell tab-shell"><code>curl <sp
configuration components. This endpoint provides the final joined configuration that Synse Server
ultimately runs with.</p>

<p>For more information on how to configure Synse Server, see the user <a href="#">documentation</a>. (TODO)</p>
<p>See the <a href="http://synse-server.readthedocs.io/en/latest/user/configuration.html">Configuration Documentation</a>
for more information.</p>
<h3 id='http-request-3'>HTTP Request</h3>
<p><code>GET http://host:5000/synse/2.0/config</code></p>
<h3 id='response'>Response</h3>
<p>The response to the <code>config</code> endpoint is the unified configuration for Synse Server. See the
<a href="#">documentation</a> for more info on what the configuration scheme looks like.</p>
<p>The response to the <code>config</code> endpoint is the unified configuration for Synse Server. The
<a href="http://synse-server.readthedocs.io/en/latest/user/configuration.html">Configuration Documentation</a>
describes the configuration scheme in more detail.</p>
<h2 id='plugins'>Plugins</h2><pre class="highlight shell tab-shell"><code>curl <span class="s2">"http://host:5000/synse/2.0/plugins"</span>
</code></pre><pre class="highlight python tab-python"><code><span class="kn">import</span> <span class="nn">requests</span>

Expand All @@ -559,8 +561,8 @@ <h2 id='plugins'>Plugins</h2><pre class="highlight shell tab-shell"><code>curl <

<p>This endpoint is added as a convenience to make it easier to determine which plugins Synse Server
is running with. Plugins can be registers with Synse Server in a variety of ways, including
file and environment configurations. See the <a href="#">documentation</a> for more on how to register plugins
with Synse Server. This endpoint shows the unified view of all registered plugins.</p>
file and environment configurations. See the <a href="http://synse-server.readthedocs.io/en/latest/index.html">User Guide</a>
for more on how to register plugins with Synse Server. This endpoint shows the unified view of all registered plugins.</p>
<h3 id='http-request-4'>HTTP Request</h3>
<p><code>GET http://host:5000/synse/2.0/plugins</code></p>
<h3 id='response-2'>Response</h3>
Expand Down Expand Up @@ -1010,7 +1012,8 @@ <h2 id='transaction'>Transaction</h2><pre class="highlight shell tab-shell"><cod

<p>If no transaction ID is given, a list of all cached transaction IDs is returned. The length
of time that a transaction is cached for is configurable. See the Synse Server configuration
<a href="#">documentation</a> for more.</p>
<a href="http://synse-server.readthedocs.io/en/latest/user/configuration.html">Configuration Documentation</a>
for more.</p>
<h3 id='http-request-8'>HTTP Request</h3>
<p><code>GET http://host:5000/synse/2.0/transaction[/{transaction id}]</code></p>
<h3 id='uri-parameters-4'>URI Parameters</h3>
Expand Down Expand Up @@ -1482,12 +1485,12 @@ <h3 id='query-parameters-3'>Query Parameters</h3>
<td><em>speed</em></td>
<td>The speed (in RPM) to set the fan to.</td>
</tr>
<tr>
<td><em>speed_percent</em></td>
<td>The speed (in percent) to set the fan to.</td>
</tr>
</tbody></table>

<aside class="notice">
In the future, the fan route will support <i>rpm</i> and <i>percent</i> parameters for setting fan speed.
</aside>

<aside class="warning">
While Synse Server supports the listed Query Parameters, not all devices will support the
corresponding actions. As a result, writing to some <i>fan</i> instances may result in error.
Expand Down

0 comments on commit 5fdc2aa

Please sign in to comment.