aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMilo Casagrande <milo.casagrande@linaro.org>2014-12-02 09:31:42 +0100
committerMilo Casagrande <milo.casagrande@linaro.org>2014-12-02 09:31:42 +0100
commit08d1e3f0eb03d74fb8446edfd472ab23fbd0a7c2 (patch)
treeb78328a5e1b82a7220859c0984214b52643626b1 /doc
parentb773905cfc4a2b6d22f88e5142d26146da8cb354 (diff)
parente2605aa619872fd71b97a22a405a54fbde4c7477 (diff)
Merge branch 'version-handler' into boot-labs
Diffstat (limited to 'doc')
-rw-r--r--doc/collection-version.rst62
-rw-r--r--doc/collections.rst1
-rw-r--r--doc/conf.py2
3 files changed, 64 insertions, 1 deletions
diff --git a/doc/collection-version.rst b/doc/collection-version.rst
new file mode 100644
index 0000000..025295d
--- /dev/null
+++ b/doc/collection-version.rst
@@ -0,0 +1,62 @@
+version
+-------
+
+GET
+***
+
+.. http:get:: /version
+
+ Provide the version number of the software running.
+
+ :reqheader Accept-Encoding: Accept the ``gzip`` coding.
+
+ :resheader Content-Type: Will be ``application/json; charset=UTF-8``.
+
+ :status 200: Resuslts found.
+
+ .. note::
+
+ This collection does not require authentication.
+
+ **Example Requests**
+
+ .. sourcecode:: http
+
+ GET /version HTTP/1.1
+ Host: api.armcloud.us
+ Accept: */*
+
+ **Example Responses**
+
+ .. sourcecode:: http
+
+ HTTP/1.1 200 OK
+ Vary: Accept-Encoding
+ Date: Mon, 24 Nov 2014 18:08:12 GMT
+ Content-Type: application/json; charset=UTF-8
+
+ {
+ "code": 200,
+ "result":
+ [
+ {
+ "version": "2014.11",
+ "full_version": "2014.11"
+ }
+ ]
+ }
+
+POST
+****
+
+.. caution::
+ Not implemented. Will return a :ref:`status code <http_status_code>`
+ of ``501``.
+
+
+DELETE
+******
+
+.. caution::
+ Not implemented. Will return a :ref:`status code <http_status_code>`
+ of ``501``.
diff --git a/doc/collections.rst b/doc/collections.rst
index a3f48a8..b1bc434 100644
--- a/doc/collections.rst
+++ b/doc/collections.rst
@@ -12,3 +12,4 @@ Collections
collection-boot
collection-batch
collection-lab
+ collection-version
diff --git a/doc/conf.py b/doc/conf.py
index 55f5b08..c1e1a10 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -24,7 +24,7 @@ sys.path.insert(
0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
)
-from app import __version__, __versionfull__
+from app.handlers import __version__, __versionfull__
# -- General configuration ------------------------------------------------