Update cloud download api docs w.r.t to updates to error reports.

galaxyproject · Oct 11, 2018 · 081e4eb · 081e4eb
1 parent 7c599f8
commit 081e4eb
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/lib/galaxy/webapps/galaxy/api/cloud.py b/lib/galaxy/webapps/galaxy/api/cloud.py
@@ -172,8 +172,12 @@ def download(self, trans, payload, **kwargs):
                             **  `object`:                   The name of object is queued to be created.
                             **  `job_id`:                   The id of the queued download job.
 
-                        *   `failed_dataset_labels`:        A list of datasets Galaxy failed to create (and queue) a
-                                                            download job for.
+                        *   `failed_dataset_labels`:        A list of JSON objects with the following key-value pair
+                                                            representing the datasets Galaxy failed to create
+                                                            (and queue) download job for:
+                            **  `object`:                   The name of object is queued to be created.
+                            **  `error`:                    A descriptive error message.
+
         """
         missing_arguments = []
         encoded_history_id = payload.get("history_id", None)