From 682215f6a1417ee8381573c59eef5349d1799ab4 Mon Sep 17 00:00:00 2001
From: dlavigne <dru@freebsd.org>
Date: Thu, 3 Mar 2016 09:28:40 -0500
Subject: [PATCH] Document listisos action.

---
 api/classes/iohyve.rst | 50 ++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 48 insertions(+), 2 deletions(-)

diff --git a/api/classes/iohyve.rst b/api/classes/iohyve.rst
index 8343c85..b15421f 100644
--- a/api/classes/iohyve.rst
+++ b/api/classes/iohyve.rst
@@ -20,8 +20,8 @@ Every iohyve class request contains the following parameters:
 | namespace                       | sysadm        |                                                                                                                      |
 |                                 |               |                                                                                                                      |
 +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
-| action                          |               | supported actions include "listvms", "fetchiso", "renameiso", "rmiso", "setup",  "issetup", "create",  "install",    |
-|                                 |               | "start", "stop"                                                                                                      |
+| action                          |               | supported actions include "listvms", "fetchiso", "listisos", "renameiso", "rmiso", "setup",  "issetup", "create",    |
+|                                 |               | "install", "start", "stop"                                                                                           |
 |                                 |               |                                                                                                                      |
 +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
 
@@ -148,6 +148,52 @@ The "fetchiso" action is used to retrieve the installation ISO. It is used with
   "namespace": "sysadm"
  }
  
+.. index:: listisos, iohyve
+
+.. _List ISOs:
+
+List ISOs
+=========
+
+The "listisos" action lists all the known ISO files which iohyve can use.
+
+**REST Request**
+
+.. code-block:: json
+ 
+ PUT /sysadm/iohyve
+ {
+   "action" : "listisos"
+ }
+
+**WebSocket Request**
+
+.. code-block:: json
+ 
+ {
+   "name" : "iohyve",
+   "namespace" : "sysadm",
+   "id" : "fooid",
+   "args" : {
+      "action" : "listisos"
+   }
+ }
+
+**Response**
+
+.. code-block:: json
+ 
+ {
+  "args": {
+    "listisos": [
+      "TRUEOS10.2-RELEASE-08-19-2015-x64-netinstall.iso"
+    ]
+  },
+  "id": "fooid",
+  "name": "response",
+  "namespace": "sysadm"
+ }
+ 
 .. index:: renameiso, iohyve
 
 .. _Rename ISO: