summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorZhiQiang Fan <zhiqiang.fan@huawei.com>2015-02-11 15:24:11 +0800
committerZhiQiang Fan <zhiqiang.fan@huawei.com>2015-02-11 15:24:11 +0800
commitf992d5149b6957e98f2e2ff64d8e9b9ad037ecd3 (patch)
tree1f8079f91a382cb6fb9b0dfe24d6d375ec87531d /doc
parentce34a4eae0f6803b09a1ba6d9757d47d6d654ed4 (diff)
downloadceilometer-f992d5149b6957e98f2e2ff64d8e9b9ad037ecd3.tar.gz
Add doc for version list API
We can request version list by access endpoint root path, but this is not mentioned in our webapi document. Change-Id: I61d1b805f3bd83b5bc527ab84b3a36cca9a70f3e
Diffstat (limited to 'doc')
-rw-r--r--doc/source/webapi/index.rst39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/source/webapi/index.rst b/doc/source/webapi/index.rst
index 408fba69..0e0b9fc8 100644
--- a/doc/source/webapi/index.rst
+++ b/doc/source/webapi/index.rst
@@ -7,3 +7,42 @@
v1
v2
+
+You can get API version list via request to endpoint root path. For example::
+
+ curl -H "X-AUTH-TOKEN: fa2ec18631f94039a5b9a8b4fe8f56ad" http://127.0.0.1:8777
+
+Sample response::
+
+ {
+ "versions": {
+ "values": [
+ {
+ "id": "v2",
+ "links": [
+ {
+ "href": "http://127.0.0.1:8777/v2",
+ "rel": "self"
+ },
+ {
+ "href": "http://docs.openstack.org/",
+ "rel": "describedby",
+ "type": "text/html"
+ }
+ ],
+ "media-types": [
+ {
+ "base": "application/json",
+ "type": "application/vnd.openstack.telemetry-v2+json"
+ },
+ {
+ "base": "application/xml",
+ "type": "application/vnd.openstack.telemetry-v2+xml"
+ }
+ ],
+ "status": "stable",
+ "updated": "2013-02-13T00:00:00Z"
+ }
+ ]
+ }
+ }