Updated docs for hosts statuses and endpoint.

doc/endpoints.rst

@@ -0,0 +1,71 @@
+REST Endpoints
+==============
+
+Host
+----
+
+**Endpoint**: /api/v0/host/{IP}
+
+GET
+```
+
+PUT
+```
+
+DELETE
+``````
+
+Hosts
+-----
+
+**Endpoint**: /api/v0/hosts
+
+
+GET
+```
+Retrieve a list of hosts.
+
+.. code-block:: javascript
+
+   [
+       {
+           "address": string,
+           "status":  enum(string),
+           "os": string,
+           "cpus": int,
+           "memory": int,
+           "space": int,
+           "last_check": string
+       }...
+   ]
+
+.. note::
+   See :ref:`host-statuses` for a list and description of host statuses.
+
+
+Example
+~~~~~~~
+
+.. code-block:: javascript
+
+   [
+       {
+           "address": "192.168.100.50",
+           "status": "active",
+           "os": "atomic",
+           "cpus": 4,
+           "memory": 11989228,
+           "space": 487652,
+           "last_check": "2015-12-17T15:48:18.710454"
+       },
+       {
+           "address": "192.168.100.51",
+           "status": "active",
+           "os": "atomic",
+           "cpus": 3,
+           "memory": 11989228,
+           "space": 487652,
+           "last_check": "2015-12-17T15:48:30.401090"
+       }
+   ]
+

doc/index.rst

@@ -12,6 +12,8 @@ Contents:
    :maxdepth: 2
 
    authentication
+   endpoints
+   statuses
 
 API Documentation:
 

doc/statuses.rst

@@ -0,0 +1,13 @@
+Statuses
+========
+
+.. _host-statuses:
+
+Host Statuses
+-------------
+
+* **investigating**: The host has passed credentials to commissaire which is now looking at the system.
+* **bootstrapping**: The host is going through changes to become active.
+* **active**: The host is part of the cluster and is registered with the Container Manager.
+* **inactive**: The host exists but is currently not actively working as a node for the Container Manager.
+* **disassociated**: The host exists but is not associated with the Container Manager.