From e4d0ae92aebe4d2d4a15c9d9d53bb757dd9a394c Mon Sep 17 00:00:00 2001 From: Brian O'Connor Date: Mon, 17 Sep 2018 13:27:54 -0700 Subject: [PATCH] improving the quick status description --- openapi/workflow_execution_service.swagger.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/openapi/workflow_execution_service.swagger.yaml b/openapi/workflow_execution_service.swagger.yaml index fedf98cb..573ce8d9 100644 --- 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: