feat: octokit.actions.deleteWorkflowRunLogs() (#68)

Co-authored-by: Octokit Bot <[email protected]>

Author: github-actions[bot]

docs/actions/deleteWorkflowRunLogs.md

@@ -0,0 +1,42 @@
+# Delete workflow run logs
+
+Deletes all logs for a workflow run. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
+
+```js
+octokit.actions.deleteWorkflowRunLogs({
+  owner,
+  repo,
+  run_id,
+});
+```
+
+## Parameters
+
+<table>
+  <thead>
+    <tr>
+      <th>name</th>
+      <th>required</th>
+      <th>description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr><td>owner</td><td>yes</td><td>
+
+owner parameter
+
+</td></tr>
+<tr><td>repo</td><td>yes</td><td>
+
+repo parameter
+
+</td></tr>
+<tr><td>run_id</td><td>yes</td><td>
+
+run_id parameter
+
+</td></tr>
+  </tbody>
+</table>
+
+See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/workflow_runs/#delete-workflow-run-logs).

scripts/update-endpoints/generated/endpoints.json

@@ -14057,6 +14057,62 @@
     "responses": [],
     "renamed": null
   },
+  {
+    "name": "Delete workflow run logs",
+    "scope": "actions",
+    "id": "deleteWorkflowRunLogs",
+    "method": "DELETE",
+    "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs",
+    "isDeprecated": false,
+    "isLegacy": false,
+    "description": "Deletes all logs for a workflow run. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.",
+    "documentationUrl": "https://developer.github.com/v3/actions/workflow_runs/#delete-workflow-run-logs",
+    "previews": [],
+    "headers": [],
+    "parameters": [
+      {
+        "name": "owner",
+        "description": "owner parameter",
+        "in": "PATH",
+        "type": "string",
+        "required": true,
+        "enum": null,
+        "allowNull": false,
+        "mapToData": null,
+        "validation": null,
+        "alias": null,
+        "deprecated": null
+      },
+      {
+        "name": "repo",
+        "description": "repo parameter",
+        "in": "PATH",
+        "type": "string",
+        "required": true,
+        "enum": null,
+        "allowNull": false,
+        "mapToData": null,
+        "validation": null,
+        "alias": null,
+        "deprecated": null
+      },
+      {
+        "name": "run_id",
+        "description": "run_id parameter",
+        "in": "PATH",
+        "type": "integer",
+        "required": true,
+        "enum": null,
+        "allowNull": false,
+        "mapToData": null,
+        "validation": null,
+        "alias": null,
+        "deprecated": null
+      }
+    ],
+    "responses": [],
+    "renamed": null
+  },
   {
     "name": "Re-run a workflow",
     "scope": "actions",

src/generated/endpoints.ts

@@ -19,6 +19,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
     deleteSecretFromRepo: [
       "DELETE /repos/{owner}/{repo}/actions/secrets/{name}",
     ],
+    deleteWorkflowRunLogs: [
+      "DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs",
+    ],
     downloadArtifact: [
       "GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}",
     ],

src/generated/types.ts

@@ -21728,6 +21728,11 @@ export type ActionsDeleteSecretFromRepoParams = {
   owner: string;
   repo: string;
 };
+export type ActionsDeleteWorkflowRunLogsParams = {
+  owner: string;
+  repo: string;
+  run_id: number;
+};
 export type ActionsDownloadArtifactParams = {
   archive_format: string;
   artifact_id: number;
@@ -28452,6 +28457,16 @@ export type RestEndpointMethods = {
 
       endpoint: EndpointInterface;
     };
+    /**
+     * Deletes all logs for a workflow run. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
+     */
+    deleteWorkflowRunLogs: {
+      (
+        params?: RequestParameters & ActionsDeleteWorkflowRunLogsParams
+      ): Promise<AnyResponse>;
+
+      endpoint: EndpointInterface;
+    };
     /**
      * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
      *