feat: add total_runs in response of GET /runs endpoint

ga4gh · Aug 1, 2022 · ea05099 · ea05099
1 parent c3b1985
commit ea05099
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/openapi/components/schemas/RunListResponse.yaml b/openapi/components/schemas/RunListResponse.yaml
@@ -9,4 +9,8 @@ properties:
   next_page_token:
     type: string
     description: A token which may be supplied as `page_token` in workflow run list request to get the next page of results.  An empty string indicates there are no more items to return.
+  total_runs:
+    type: integer
+    description: >-
+      Total count of workflow runs that the service has executed or is executing and the caller has permission to see.
 description: The service will return a RunListResponse when receiving a successful RunListRequest.
diff --git a/openapi/workflow_execution_service.schema.json b/openapi/workflow_execution_service.schema.json
@@ -150,6 +150,10 @@
         "next_page_token": {
           "type": "string",
           "description": "A token which may be supplied as `page_token` in workflow run list request to get the next page of results.  An empty string indicates there are no more items to return."
+        },
+        "total_runs": {
+          "type": "integer",
+          "description": "Total count of workflow runs that the service has executed or is executing and the caller has permission to see."
         }
       },
       "description": "The service will return a RunListResponse when receiving a successful RunListRequest."

diff --git a/openapi/workflow_execution_service.swagger.yaml b/openapi/workflow_execution_service.swagger.yaml
@@ -548,6 +548,10 @@ definitions:
         description: >-
           A token which may be supplied as `page_token` in workflow run list request to get the next page
           of results.  An empty string indicates there are no more items to return.
+      total_runs:
+        type: integer
+        description: >-
+          Total count of workflow runs that the service has executed or is executing and the caller has permission to see.
     description: The service will return a RunListResponse when receiving a successful RunListRequest.
   RunLog:
     type: object