update sidebar. change layout specified in http/index
This commit is contained in:
captainill
Diptanu Choudhury
parent
63b23c4e65
commit
8e81dc7ff8
|
|
@ -188,6 +188,3 @@ PLATFORMS
|
|||
|
||||
DEPENDENCIES
|
||||
middleman-hashicorp!
|
||||
|
||||
BUNDLED WITH
|
||||
1.10.6
|
||||
|
|
|
|||
|
|
@ -9,9 +9,9 @@ description: |-
|
|||
|
||||
# /v1/client/fs/cat
|
||||
|
||||
The `fs/cat` endpoint is used to read the contents of a file in an allocation
|
||||
The `/fs/cat` endpoint is used to read the contents of a file in an allocation
|
||||
directory. This API endpoint is hosted by the Nomad client and requests have to
|
||||
be made to the Nomad client where the particular allocation is running.
|
||||
be made to the Nomad client where the particular allocation was placed.
|
||||
|
||||
## GET
|
||||
|
||||
|
|
@ -25,21 +25,29 @@ be made to the Nomad client where the particular allocation is running.
|
|||
<dd>GET</dd>
|
||||
|
||||
<dt>URL</dt>
|
||||
<dd>`/v1/client/fs/cat`</dd>
|
||||
<dd>`/v1/client/fs/cat/<ALLOCATION-ID>`</dd>
|
||||
|
||||
<dt>Parameters</dt>
|
||||
<dd>
|
||||
Path - The path relative to the root of the allocation directory. It
|
||||
defaults to `/`
|
||||
<ul>
|
||||
<li>
|
||||
<span class="param">path</span>
|
||||
<span class="param-flags">required</span>
|
||||
The path relative to the root of the allocation directory. It
|
||||
defaults to `/`
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
<dt>Returns</dt>
|
||||
<dd>
|
||||
|
||||
```
|
||||
2016/03/15 15:40:56 [DEBUG] sylog-server: launching syslog server on addr:
|
||||
/tmp/plugin096499590
|
||||
|
||||
```
|
||||
|
||||
</dd>
|
||||
|
||||
</dl>
|
||||
|
|
|
|||
|
|
@ -9,9 +9,9 @@ description: |-
|
|||
|
||||
# /v1/client/fs/ls
|
||||
|
||||
The `fs/ls` endpoint is used to list files in an allocation directory. This API
|
||||
The `/fs/ls` endpoint is used to list files in an allocation directory. This API
|
||||
endpoint is hosted by the Nomad client and requests have to be made to the Nomad
|
||||
client where the particular allocation is running.
|
||||
client where the particular allocation was placed.
|
||||
|
||||
## GET
|
||||
|
||||
|
|
@ -25,16 +25,23 @@ client where the particular allocation is running.
|
|||
<dd>GET</dd>
|
||||
|
||||
<dt>URL</dt>
|
||||
<dd>`/v1/client/fs/ls`</dd>
|
||||
<dd>`/v1/client/fs/ls/<ALLOCATION-ID>`</dd>
|
||||
|
||||
<dt>Parameters</dt>
|
||||
<dd>
|
||||
Path - The path relative to the root of the allocation directory. It
|
||||
defaults to `/`
|
||||
<ul>
|
||||
<li>
|
||||
<span class="param">path</span>
|
||||
<span class="param-flags">required</span>
|
||||
The path relative to the root of the allocation directory. It
|
||||
defaults to `/`, the root of the allocation directory.
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
<dt>Returns</dt>
|
||||
<dd>
|
||||
|
||||
```javascript
|
||||
[
|
||||
{
|
||||
|
|
@ -53,6 +60,7 @@ client where the particular allocation is running.
|
|||
}
|
||||
]
|
||||
```
|
||||
|
||||
</dd>
|
||||
|
||||
</dl>
|
||||
|
|
|
|||
|
|
@ -9,9 +9,9 @@ description: |-
|
|||
|
||||
# /v1/client/fs/stat
|
||||
|
||||
The `fs/stat` endpoint is used to stat a file in an allocation directory. This
|
||||
The `/fs/stat` endpoint is used to stat a file in an allocation directory. This
|
||||
API endpoint is hosted by the Nomad client and requests have to be made to the
|
||||
Nomad client where the particular allocation is running.
|
||||
Nomad client where the particular allocation was placed.
|
||||
|
||||
## GET
|
||||
|
||||
|
|
@ -25,15 +25,22 @@ Nomad client where the particular allocation is running.
|
|||
<dd>GET</dd>
|
||||
|
||||
<dt>URL</dt>
|
||||
<dd>`/v1/client/fs/stat`</dd>
|
||||
<dd>`/v1/client/fs/stat/<ALLOCATION-ID>`</dd>
|
||||
|
||||
<dt>Parameters</dt>
|
||||
<dd>
|
||||
Path - The path of the file relative to the root of the allocation directory.
|
||||
<ul>
|
||||
<li>
|
||||
<span class="param">path</span>
|
||||
<span class="param-flags">required</span>
|
||||
The path of the file relative to the root of the allocation directory.
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
<dt>Returns</dt>
|
||||
<dd>
|
||||
|
||||
```javascript
|
||||
{
|
||||
"Name": "redis-syslog-collector.out",
|
||||
|
|
@ -43,6 +50,7 @@ Nomad client where the particular allocation is running.
|
|||
"ModTime": "2016-03-15T15:40:56.822238153-07:00"
|
||||
}
|
||||
```
|
||||
|
||||
</dd>
|
||||
|
||||
</dl>
|
||||
|
|
|
|||
|
|
@ -91,6 +91,3 @@ appropriate region.
|
|||
|
||||
By default, the output of all HTTP API requests is minimized JSON. If the client passes `pretty`
|
||||
on the query string, formatted JSON will be returned.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -88,6 +88,22 @@
|
|||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li<%= sidebar_current("docs-http-client") %>>
|
||||
<a href="#">Client</a>
|
||||
<ul class="nav nav-visible">
|
||||
<li<%= sidebar_current("docs-http-client-fs-ls") %>>
|
||||
<a href="/docs/http/client-fs-ls.html">/v1/client/fs/ls</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-http-client-fs-cat") %>>
|
||||
<a href="/docs/http/client-fs-cat.html">/v1/client/fs/cat</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-http-client-fs-stat") %>>
|
||||
<a href="/docs/http/client-fs-stat.html">/v1/client/fs/stat</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-http-regions") %>>
|
||||
<a href="/docs/http/regions.html">Regions</a>
|
||||
|
|
|
|||
Loading…
Reference in New Issue