From 32a662c47d76e3f834101a00fa12210895821a05 Mon Sep 17 00:00:00 2001 From: dlavigne Date: Thu, 3 Mar 2016 15:22:49 -0500 Subject: [PATCH] Doc version command. --- api/classes/iohyve.rst | 48 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 47 insertions(+), 1 deletion(-) diff --git a/api/classes/iohyve.rst b/api/classes/iohyve.rst index 88312f4..aff0a43 100644 --- a/api/classes/iohyve.rst +++ b/api/classes/iohyve.rst @@ -21,7 +21,7 @@ Every iohyve class request contains the following parameters: | | | | +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ | action | | supported actions include "listvms", "fetchiso", "listisos", "renameiso", "rmiso", "setup", "issetup", "create", | -| | | "install", "start", "stop", "delete", "adddisk", "listdisks", "resizedisk", and "deletedisk" | +| | | "install", "start", "stop", "delete", "adddisk", "listdisks", "resizedisk", "deletedisk", and "version" | | | | | +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ @@ -840,4 +840,50 @@ The "deletedisk" action removes the specified disk from the specified VM. "id": "fooid", "name": "response", "namespace": "sysadm" + } + + .. index:: version, iohyve + +.. _List Version: + +List Version +============ + +The "version" action displays the iohyve version. + +**REST Request** + +.. code-block:: json + + PUT /sysadm/iohyve + { + "action" : "version" + } + +**WebSocket Request** + +.. code-block:: json + + { + "namespace" : "sysadm", + "args" : { + "action" : "version" + }, + "id" : "fooid", + "name" : "iohyve" + } + +**Response** + +.. code-block:: json + + { + "args": { + "version": { + "version": "iohyve v0.7.3 2016/01/08 Bear in a Datacenter Edition" + } + }, + "id": "fooid", + "name": "response", + "namespace": "sysadm" } \ No newline at end of file