website: document regions endpoint

hashicorp · Nov 24, 2015 · 47f8978 · 47f8978
1 parent 0bee0ea
commit 47f8978
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 0 deletions.
diff --git a/command/agent/regions_endpoint.go → command/agent/region_endpoint.go b/command/agent/regions_endpoint.go → command/agent/region_endpoint.go
diff --git a/website/source/docs/http/regions.html.md b/website/source/docs/http/regions.html.md
@@ -0,0 +1,38 @@
+---
+layout: "http"
+page_title: "HTTP API: /v1/regions"
+sidebar_current: "docs-http-regions"
+description: >
+  The '/v1/regions' endpoint lists the known cluster regions.
+---
+
+# /v1/regions
+
+## GET
+
+<dl>
+  <dt>Description</dt>
+  <dd>
+    Returns the known region names.
+  </dd>
+
+  <dt>Method</dt>
+  <dd>GET</dd>
+
+  <dt>URL</dt>
+  <dd>`/v1/regions`</dd>
+
+  <dt>Parameters</dt>
+  <dd>
+    None
+  </dd>
+
+  <dt>Returns</dt>
+  <dd>
+
+    ```javascript
+    ["region1","region2"]
+    ```
+
+  </dd>
+</dl>
diff --git a/website/source/layouts/http.erb b/website/source/layouts/http.erb
@@ -89,6 +89,10 @@
 					</ul>
                 </li>
 
+                <li<%= sidebar_current("docs-http-regions") %>>
+                    <a href="/docs/http/regions.html">Regions</a>
+                </li>
+
 				<li<%= sidebar_current("docs-http-status") %>>
 					<a href="/docs/http/status.html">Status</a>
                 </li>