From 47f8978fab8cf30ec36c5f36b31b0ac3576666fd Mon Sep 17 00:00:00 2001 From: Ryan Uber Date: Mon, 23 Nov 2015 22:41:41 -0800 Subject: [PATCH] website: document regions endpoint --- ...regions_endpoint.go => region_endpoint.go} | 0 website/source/docs/http/regions.html.md | 38 +++++++++++++++++++ website/source/layouts/http.erb | 4 ++ 3 files changed, 42 insertions(+) rename command/agent/{regions_endpoint.go => region_endpoint.go} (100%) create mode 100644 website/source/docs/http/regions.html.md diff --git a/command/agent/regions_endpoint.go b/command/agent/region_endpoint.go similarity index 100% rename from command/agent/regions_endpoint.go rename to command/agent/region_endpoint.go diff --git a/website/source/docs/http/regions.html.md b/website/source/docs/http/regions.html.md new file mode 100644 index 00000000000..5de35509c59 --- /dev/null +++ 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 + +
+
Description
+
+ Returns the known region names. +
+ +
Method
+
GET
+ +
URL
+
`/v1/regions`
+ +
Parameters
+
+ None +
+ +
Returns
+
+ + ```javascript + ["region1","region2"] + ``` + +
+
diff --git a/website/source/layouts/http.erb b/website/source/layouts/http.erb index 1589df8088e..f22413041c1 100644 --- a/website/source/layouts/http.erb +++ b/website/source/layouts/http.erb @@ -89,6 +89,10 @@ + > + Regions + + > Status