better described status get on run

ga4gh · Sep 17, 2018 · 05c129c · 05c129c
1 parent 7eaf1b6
commit 05c129c
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/openapi/workflow_execution_service.swagger.yaml b/openapi/workflow_execution_service.swagger.yaml
@@ -208,6 +208,12 @@ paths:
   /runs/{run_id}:
     get:
       summary: Get detailed info about a workflow run.
+      description: |-
+        This endpoint provides detailed information about a given workflow run.
+        The returned result has information about the outputs produced by this workflow
+        (if available), a log object which allows the stderr and stdout to be retrieved,
+        a log array so stderr/stdout for individual tasks can be retrieved,
+        and the overall state of the workflow run (e.g. RUNNING, see the State section).
       x-swagger-router-controller: ga4gh.wes.server
       operationId: GetRunLog
       responses: