Getting a list of Jobs.

JIRA: STORPERF-184

- Remove "required" condition for getting Job.
- Update documentation.

Change-Id: I4dad1dfdb998c78c9c6620760614a36dd62318ec
Signed-off-by: Taseer Ahmed <taseer94@gmail.com>

diff --git a/docker/storperf-master/rest_server.py b/docker/storperf-master/rest_server.py
index 3df2856..d551b57 100644 (file)
--- a/docker/storperf-master/rest_server.py
+++ b/docker/storperf-master/rest_server.py
@@ -160,7 +160,7 @@ class Job(Resource):
                 "name": "id",
                 "description": "The UUID of the workload in the format "
                 "NNNNNNNN-NNNN-NNNN-NNNN-NNNNNNNNNNNN",
-                "required": True,
+                "required": False,
                 "type": "string",
                 "allowMultiple": False,
                 "paramType": "query"

diff --git a/docs/testing/user/test-usage.rst b/docs/testing/user/test-usage.rst
index 8ffa27a..586ba7a 100644 (file)
--- a/docs/testing/user/test-usage.rst
+++ b/docs/testing/user/test-usage.rst
@@ -232,6 +232,15 @@ remain to be executed.
 
   curl -X DELETE --header 'Accept: application/json' http://StorPerf:5000/api/v1.0/jobs
 
+List all Jobs
+=============
+A list of all Jobs can also be queried. You just need to issue a GET request without any
+Job ID.
+
+.. code-block:: bash
+
+  curl -X GET --header 'Accept: application/json' http://StorPerf/api/v1.0/jobs
+
 Delete the Environment
 ======================
 After you are done testing, you can have StorPerf delete the Heat stack by