improving the quick status description

ga4gh · Sep 17, 2018 · e4d0ae9 · e4d0ae9
1 parent 05c129c
commit e4d0ae9
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/openapi/workflow_execution_service.swagger.yaml b/openapi/workflow_execution_service.swagger.yaml
@@ -279,6 +279,10 @@ paths:
   /runs/{run_id}/status:
     get:
       summary: Get quick status info about a workflow run.
+      description: |-
+        This provides an abbreviated (and likely fast depending on implementation)
+        status of the running workflow, returning a simple result with the 
+        overall state of the workflow run (e.g. RUNNING, see the State section).
       x-swagger-router-controller: ga4gh.wes.server
       operationId: GetRunStatus
       responses: