feat: `GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{atte…

…mpt_number}/jobs` (#174)
octokit · Oct 11, 2021 · fe05fa8 · fe05fa8
1 parent 99c9ad6
commit fe05fa8
Show file tree

Hide file tree

Showing 15 changed files with 238 additions and 10 deletions.
diff --git a/cache/api.github.com.json b/cache/api.github.com.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "5.8.0",
+    "version": "5.9.0",
     "title": "GitHub's official OpenAPI spec + Octokit extension",
     "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -14123,6 +14123,59 @@
         "x-octokit": {}
       }
     },
+    "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": {
+      "get": {
+        "summary": "List jobs for a workflow run attempt",
+        "description": "Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).",
+        "tags": ["actions"],
+        "operationId": "actions/list-jobs-for-workflow-run-attempt",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run-attempt"
+        },
+        "parameters": [
+          { "$ref": "#/components/parameters/owner" },
+          { "$ref": "#/components/parameters/repo" },
+          { "$ref": "#/components/parameters/run-id" },
+          { "$ref": "#/components/parameters/attempt-number" },
+          { "$ref": "#/components/parameters/per-page" },
+          { "$ref": "#/components/parameters/page" }
+        ],
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": ["total_count", "jobs"],
+                  "properties": {
+                    "total_count": { "type": "integer" },
+                    "jobs": {
+                      "type": "array",
+                      "items": { "$ref": "#/components/schemas/job" }
+                    }
+                  }
+                },
+                "examples": {
+                  "default": { "$ref": "#/components/examples/job-paginated" }
+                }
+              }
+            },
+            "headers": { "Link": { "$ref": "#/components/headers/link" } }
+          },
+          "404": { "$ref": "#/components/responses/not_found" }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "previews": [],
+          "category": "actions",
+          "subcategory": "workflow-jobs"
+        },
+        "x-octokit": {}
+      }
+    },
     "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": {
       "get": {
         "summary": "Download workflow run attempt logs",
@@ -29587,6 +29640,9 @@
                 }
               }
             }
+          },
+          "422": {
+            "description": "Response if you upload an asset with the same filename as another uploaded asset"
           }
         },
         "x-github": {

diff --git a/cache/ghes-3.0.json b/cache/ghes-3.0.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "5.8.0",
+    "version": "5.9.0",
     "title": "GitHub's official OpenAPI spec + Octokit extension",
     "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -28670,6 +28670,9 @@
                 }
               }
             }
+          },
+          "422": {
+            "description": "Response if you upload an asset with the same filename as another uploaded asset"
           }
         },
         "x-github": {

diff --git a/cache/ghes-3.1.json b/cache/ghes-3.1.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "5.8.0",
+    "version": "5.9.0",
     "title": "GitHub's official OpenAPI spec + Octokit extension",
     "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -29005,6 +29005,9 @@
                 }
               }
             }
+          },
+          "422": {
+            "description": "Response if you upload an asset with the same filename as another uploaded asset"
           }
         },
         "x-github": {

diff --git a/cache/ghes-3.2.json b/cache/ghes-3.2.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "5.8.0",
+    "version": "5.9.0",
     "title": "GitHub's official OpenAPI spec + Octokit extension",
     "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -29751,6 +29751,9 @@
                 }
               }
             }
+          },
+          "422": {
+            "description": "Response if you upload an asset with the same filename as another uploaded asset"
           }
         },
         "x-github": {
@@ -37943,6 +37946,20 @@
         "responses": { "501": { "description": "Not Implemented" } }
       }
     },
+    "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": {
+      "get": {
+        "summary": "List jobs for a workflow run attempt",
+        "description": "This endpoint does not exist ghes-3.2.json. It was added in api.github.com.json",
+        "tags": ["actions"],
+        "operationId": "actions/list-jobs-for-workflow-run-attempt",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run-attempt"
+        },
+        "x-octokit": { "api.github.com.json": "removed" },
+        "responses": { "501": { "description": "Not Implemented" } }
+      }
+    },
     "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": {
       "get": {
         "summary": "Download workflow run attempt logs",

diff --git a/cache/github.ae.json b/cache/github.ae.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "5.8.0",
+    "version": "5.9.0",
     "title": "GitHub's official OpenAPI spec + Octokit extension",
     "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -11749,6 +11749,59 @@
         "x-octokit": {}
       }
     },
+    "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": {
+      "get": {
+        "summary": "List jobs for a workflow run attempt",
+        "description": "Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).",
+        "tags": ["actions"],
+        "operationId": "actions/list-jobs-for-workflow-run-attempt",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-jobs-for-a-workflow-run-attempt"
+        },
+        "parameters": [
+          { "$ref": "#/components/parameters/owner" },
+          { "$ref": "#/components/parameters/repo" },
+          { "$ref": "#/components/parameters/run-id" },
+          { "$ref": "#/components/parameters/attempt-number" },
+          { "$ref": "#/components/parameters/per-page" },
+          { "$ref": "#/components/parameters/page" }
+        ],
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": ["total_count", "jobs"],
+                  "properties": {
+                    "total_count": { "type": "integer" },
+                    "jobs": {
+                      "type": "array",
+                      "items": { "$ref": "#/components/schemas/job" }
+                    }
+                  }
+                },
+                "examples": {
+                  "default": { "$ref": "#/components/examples/job-paginated" }
+                }
+              }
+            },
+            "headers": { "Link": { "$ref": "#/components/headers/link" } }
+          },
+          "404": { "$ref": "#/components/responses/not_found" }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "previews": [],
+          "category": "actions",
+          "subcategory": "workflow-jobs"
+        },
+        "x-octokit": {}
+      }
+    },
     "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": {
       "get": {
         "summary": "Download workflow run attempt logs",
@@ -25936,6 +25989,9 @@
                 }
               }
             }
+          },
+          "422": {
+            "description": "Response if you upload an asset with the same filename as another uploaded asset"
           }
         },
         "x-github": {

diff --git a/packages/openapi-types-ghes-3.0/package.json b/packages/openapi-types-ghes-3.0/package.json
@@ -12,5 +12,5 @@
   "types": "types.d.ts",
   "author": "Gregor Martynus (https://twitter.com/gr2m)",
   "license": "MIT",
-  "octokit": { "openapi-version": "5.8.0" }
+  "octokit": { "openapi-version": "5.9.0" }
 }
diff --git a/packages/openapi-types-ghes-3.0/types.d.ts b/packages/openapi-types-ghes-3.0/types.d.ts
@@ -25153,6 +25153,8 @@ export interface operations {
           "application/json": components["schemas"]["release-asset"];
         };
       };
+      /** Response if you upload an asset with the same filename as another uploaded asset */
+      422: unknown;
     };
     requestBody: {
       content: {

diff --git a/packages/openapi-types-ghes-3.1/package.json b/packages/openapi-types-ghes-3.1/package.json
@@ -12,5 +12,5 @@
   "types": "types.d.ts",
   "author": "Gregor Martynus (https://twitter.com/gr2m)",
   "license": "MIT",
-  "octokit": { "openapi-version": "5.8.0" }
+  "octokit": { "openapi-version": "5.9.0" }
 }
diff --git a/packages/openapi-types-ghes-3.1/types.d.ts b/packages/openapi-types-ghes-3.1/types.d.ts
@@ -25778,6 +25778,8 @@ export interface operations {
           "application/json": components["schemas"]["release-asset"];
         };
       };
+      /** Response if you upload an asset with the same filename as another uploaded asset */
+      422: unknown;
     };
     requestBody: {
       content: {

diff --git a/packages/openapi-types-ghes-3.2/package.json b/packages/openapi-types-ghes-3.2/package.json
@@ -12,5 +12,5 @@
   "types": "types.d.ts",
   "author": "Gregor Martynus (https://twitter.com/gr2m)",
   "license": "MIT",
-  "octokit": { "openapi-version": "5.8.0" }
+  "octokit": { "openapi-version": "5.9.0" }
 }
diff --git a/packages/openapi-types-ghes-3.2/types.d.ts b/packages/openapi-types-ghes-3.2/types.d.ts
@@ -4817,6 +4817,10 @@ export interface paths {
     /** This endpoint does not exist ghes-3.2.json. It was added in api.github.com.json */
     get: operations["actions/get-workflow-run-attempt"];
   };
+  "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": {
+    /** This endpoint does not exist ghes-3.2.json. It was added in api.github.com.json */
+    get: operations["actions/list-jobs-for-workflow-run-attempt"];
+  };
   "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": {
     /** This endpoint does not exist ghes-3.2.json. It was added in api.github.com.json */
     get: operations["actions/download-workflow-run-attempt-logs"];
@@ -26934,6 +26938,8 @@ export interface operations {
           "application/json": components["schemas"]["release-asset"];
         };
       };
+      /** Response if you upload an asset with the same filename as another uploaded asset */
+      422: unknown;
     };
     requestBody: {
       content: {
@@ -31290,6 +31296,13 @@ export interface operations {
     };
   };
   /** This endpoint does not exist ghes-3.2.json. It was added in api.github.com.json */
+  "actions/list-jobs-for-workflow-run-attempt": {
+    responses: {
+      /** Not Implemented */
+      501: unknown;
+    };
+  };
+  /** This endpoint does not exist ghes-3.2.json. It was added in api.github.com.json */
   "actions/download-workflow-run-attempt-logs": {
     responses: {
       /** Not Implemented */

diff --git a/packages/openapi-types-github.ae/package.json b/packages/openapi-types-github.ae/package.json
@@ -12,5 +12,5 @@
   "types": "types.d.ts",
   "author": "Gregor Martynus (https://twitter.com/gr2m)",
   "license": "MIT",
-  "octokit": { "openapi-version": "5.8.0" }
+  "octokit": { "openapi-version": "5.9.0" }
 }
diff --git a/packages/openapi-types-github.ae/types.d.ts b/packages/openapi-types-github.ae/types.d.ts
@@ -1397,6 +1397,10 @@ export interface paths {
      */
     get: operations["actions/get-workflow-run-attempt"];
   };
+  "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": {
+    /** Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters). */
+    get: operations["actions/list-jobs-for-workflow-run-attempt"];
+  };
   "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": {
     /**
      * Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after
@@ -16543,6 +16547,38 @@ export interface operations {
       };
     };
   };
+  /** Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters). */
+  "actions/list-jobs-for-workflow-run-attempt": {
+    parameters: {
+      path: {
+        owner: components["parameters"]["owner"];
+        repo: components["parameters"]["repo"];
+        /** The id of the workflow run. */
+        run_id: components["parameters"]["run-id"];
+        /** The attempt number of the workflow run. */
+        attempt_number: components["parameters"]["attempt-number"];
+      };
+      query: {
+        /** Results per page (max 100) */
+        per_page?: components["parameters"]["per-page"];
+        /** Page number of the results to fetch. */
+        page?: components["parameters"]["page"];
+      };
+    };
+    responses: {
+      /** Response */
+      200: {
+        headers: {};
+        content: {
+          "application/json": {
+            total_count: number;
+            jobs: components["schemas"]["job"][];
+          };
+        };
+      };
+      404: components["responses"]["not_found"];
+    };
+  };
   /**
    * Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after
    * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to
@@ -24310,6 +24346,8 @@ export interface operations {
           "application/json": components["schemas"]["release-asset"];
         };
       };
+      /** Response if you upload an asset with the same filename as another uploaded asset */
+      422: unknown;
     };
     requestBody: {
       content: {

diff --git a/packages/openapi-types/package.json b/packages/openapi-types/package.json
@@ -12,5 +12,5 @@
   "types": "types.d.ts",
   "author": "Gregor Martynus (https://twitter.com/gr2m)",
   "license": "MIT",
-  "octokit": { "openapi-version": "5.8.0" }
+  "octokit": { "openapi-version": "5.9.0" }
 }