diff --git a/cache/api.github.com.deref.json b/cache/api.github.com.deref.json index 192f8c981..873643c5b 100644 --- a/cache/api.github.com.deref.json +++ b/cache/api.github.com.deref.json @@ -119,6 +119,10 @@ "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." @@ -35078,12 +35082,6 @@ "ssh_key_fingerprints": { "type": "object", "properties": { - "MD5_RSA": { - "type": "string" - }, - "MD5_DSA": { - "type": "string" - }, "SHA256_RSA": { "type": "string" }, @@ -35165,8 +35163,6 @@ "value": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { - "MD5_RSA": "16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48", - "MD5_DSA": "ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c", "SHA256_RSA": "nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8", "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ" }, @@ -102241,7 +102237,7 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { "get": { "summary": "Get workflow run usage", - "description": "**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see \"[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage).\"\n\nGets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone 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.", + "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone 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.", "tags": [ "actions" ], @@ -105046,7 +105042,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { "get": { "summary": "Get workflow usage", - "description": "**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see \"[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage).\"\n\nGets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. 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.", + "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. 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.", "tags": [ "actions" ], @@ -124189,7 +124185,7 @@ "properties": { "number": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false }, @@ -124553,7 +124549,7 @@ "properties": { "number": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false }, @@ -124941,11 +124937,11 @@ { "name": "alert_number", "in": "path", - "description": "The code scanning alert number.", + "description": "The security alert number, found at the end of the security alert's URL.", "required": true, "schema": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false } @@ -125006,7 +125002,7 @@ "properties": { "number": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false }, @@ -125555,6 +125551,12 @@ }, "404": { "description": "Response if `commit_sha` or `ref` cannot be found" + }, + "400": { + "description": "Response if the `sarif` field is invalid" + }, + "413": { + "description": "Response if the `sarif` field is too large" } }, "x-github": { @@ -155709,7 +155711,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -155930,7 +155932,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" } }, "required": [ @@ -156049,7 +156051,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -156401,7 +156403,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -156738,7 +156740,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -229535,6 +229537,990 @@ } } }, + "/repos/{owner}/{repo}/secret-scanning/alerts": { + "get": { + "summary": "List secret scanning alerts for a repository", + "description": "Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-alerts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "state", + "in": "query", + "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "resolved" + ] + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "state": { + "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", + "type": "string", + "enum": [ + "open", + "resolved" + ] + }, + "resolution": { + "type": "string", + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`.", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests" + ] + }, + { + "enum": [ + null + ] + } + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "number": 2, + "created_at": "2020-11-06T18:48:51Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", + "state": "resolved", + "resolution": "false_positive", + "resolved_at": "2020-11-07T02:47:13Z", + "resolved_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "secret_type": "adafruit_io_key", + "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX" + }, + { + "number": 1, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", + "html_url": "https://github.com/owner/repo/security/secret-scanning/1", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" + } + ] + } + } + } + } + }, + "404": { + "description": "Repository is public or secret scanning is disabled for the repository" + }, + "503": { + "description": "Service Unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "secret-scanning", + "subcategory": null + } + } + }, + "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + "get": { + "summary": "Get a secret scanning alert", + "description": "Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/get-alert", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/secret-scanning#get-a-secret-scanning-alert" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "alert_number", + "in": "path", + "description": "The security alert number, found at the end of the security alert's URL.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + } + } + ], + "responses": { + "200": { + "description": "Default response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "state": { + "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", + "type": "string", + "enum": [ + "open", + "resolved" + ] + }, + "resolution": { + "type": "string", + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`.", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests" + ] + }, + { + "enum": [ + null + ] + } + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + } + } + }, + "examples": { + "default": { + "value": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" + } + } + } + } + } + }, + "404": { + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + "503": { + "description": "Service Unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "secret-scanning", + "subcategory": null + } + }, + "patch": { + "summary": "Update a secret scanning alert", + "description": "Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.", + "operationId": "secret-scanning/update-alert", + "tags": [ + "secret-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/secret-scanning#update-a-secret-scanning-alert" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "alert_number", + "in": "path", + "description": "The security alert number, found at the end of the security alert's URL.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", + "type": "string", + "enum": [ + "open", + "resolved" + ] + }, + "resolution": { + "type": "string", + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`.", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests" + ] + }, + { + "enum": [ + null + ] + } + ] + } + }, + "required": [ + "state" + ] + }, + "example": { + "state": "resolved", + "resolution": "false_positive" + } + } + } + }, + "responses": { + "200": { + "description": "Default response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "state": { + "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", + "type": "string", + "enum": [ + "open", + "resolved" + ] + }, + "resolution": { + "type": "string", + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`.", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests" + ] + }, + { + "enum": [ + null + ] + } + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + } + } + }, + "examples": { + "default": { + "value": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", + "state": "resolved", + "resolution": "used_in_tests", + "resolved_at": "2020-11-16T22:42:07Z", + "resolved_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" + } + } + } + } + } + }, + "404": { + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + "422": { + "description": "State does not match the resolution" + }, + "503": { + "description": "Service Unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "secret-scanning" + } + } + }, "/repos/{owner}/{repo}/stargazers": { "get": { "summary": "List stargazers", diff --git a/cache/api.github.com.json b/cache/api.github.com.json index c55a67c0f..0ff1097a4 100644 --- a/cache/api.github.com.json +++ b/cache/api.github.com.json @@ -119,6 +119,10 @@ "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." @@ -18089,7 +18093,7 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { "get": { "summary": "Get workflow run usage", - "description": "**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see \"[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage).\"\n\nGets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone 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.", + "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone 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.", "tags": [ "actions" ], @@ -18765,7 +18769,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { "get": { "summary": "Get workflow usage", - "description": "**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see \"[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage).\"\n\nGets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. 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.", + "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. 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.", "tags": [ "actions" ], @@ -22846,6 +22850,12 @@ }, "404": { "description": "Response if `commit_sha` or `ref` cannot be found" + }, + "400": { + "description": "Response if the `sarif` field is invalid" + }, + "413": { + "description": "Response if the `sarif` field is too large" } }, "x-github": { @@ -27294,7 +27304,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" } }, "required": [ @@ -36518,6 +36528,220 @@ } } }, + "/repos/{owner}/{repo}/secret-scanning/alerts": { + "get": { + "summary": "List secret scanning alerts for a repository", + "description": "Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-alerts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "state", + "in": "query", + "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "resolved" + ] + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-alert" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-list" + } + } + } + } + }, + "404": { + "description": "Repository is public or secret scanning is disabled for the repository" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "secret-scanning", + "subcategory": null + } + } + }, + "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + "get": { + "summary": "Get a secret scanning alert", + "description": "Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/get-alert", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/secret-scanning#get-a-secret-scanning-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/alert_number" + } + ], + "responses": { + "200": { + "description": "Default response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-alert" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-open" + } + } + } + } + }, + "404": { + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "secret-scanning", + "subcategory": null + } + }, + "patch": { + "summary": "Update a secret scanning alert", + "description": "Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.", + "operationId": "secret-scanning/update-alert", + "tags": [ + "secret-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/secret-scanning#update-a-secret-scanning-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/alert_number" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + } + }, + "required": [ + "state" + ] + }, + "example": { + "state": "resolved", + "resolution": "false_positive" + } + } + } + }, + "responses": { + "200": { + "description": "Default response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-alert" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-resolved" + } + } + } + } + }, + "404": { + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + "422": { + "description": "State does not match the resolution" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "secret-scanning" + } + } + }, "/repos/{owner}/{repo}/stargazers": { "get": { "summary": "List stargazers", @@ -52157,12 +52381,6 @@ "ssh_key_fingerprints": { "type": "object", "properties": { - "MD5_RSA": { - "type": "string" - }, - "MD5_DSA": { - "type": "string" - }, "SHA256_RSA": { "type": "string" }, @@ -57883,27 +58101,27 @@ "type": "string", "description": "The full Git reference, formatted as `refs/heads/`." }, - "code-scanning-alert-number": { + "alert-number": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false }, - "code-scanning-alert-created-at": { + "alert-created-at": { "type": "string", "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true, "nullable": false }, - "code-scanning-alert-url": { + "alert-url": { "type": "string", "description": "The REST API URL of the alert resource.", "format": "uri", "readOnly": true, "nullable": false }, - "code-scanning-alert-html-url": { + "alert-html-url": { "type": "string", "description": "The GitHub URL of the alert resource.", "format": "uri", @@ -57982,16 +58200,16 @@ "type": "object", "properties": { "number": { - "$ref": "#/components/schemas/code-scanning-alert-number" + "$ref": "#/components/schemas/alert-number" }, "created_at": { - "$ref": "#/components/schemas/code-scanning-alert-created-at" + "$ref": "#/components/schemas/alert-created-at" }, "url": { - "$ref": "#/components/schemas/code-scanning-alert-url" + "$ref": "#/components/schemas/alert-url" }, "html_url": { - "$ref": "#/components/schemas/code-scanning-alert-html-url" + "$ref": "#/components/schemas/alert-html-url" }, "state": { "$ref": "#/components/schemas/code-scanning-alert-state" @@ -58049,16 +58267,16 @@ "type": "object", "properties": { "number": { - "$ref": "#/components/schemas/code-scanning-alert-number" + "$ref": "#/components/schemas/alert-number" }, "created_at": { - "$ref": "#/components/schemas/code-scanning-alert-created-at" + "$ref": "#/components/schemas/alert-created-at" }, "url": { - "$ref": "#/components/schemas/code-scanning-alert-url" + "$ref": "#/components/schemas/alert-url" }, "html_url": { - "$ref": "#/components/schemas/code-scanning-alert-html-url" + "$ref": "#/components/schemas/alert-html-url" }, "instances": { "$ref": "#/components/schemas/code-scanning-alert-instances" @@ -60709,7 +60927,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "$ref": "#/components/schemas/webhook-config-secret" @@ -63905,6 +64123,74 @@ "url" ] }, + "secret-scanning-alert-state": { + "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", + "type": "string", + "enum": [ + "open", + "resolved" + ] + }, + "secret-scanning-alert-resolution": { + "type": "string", + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`.", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests" + ] + }, + { + "enum": [ + null + ] + } + ] + }, + "secret-scanning-alert": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "$ref": "#/components/schemas/simple-user" + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + } + } + }, "stargazer": { "title": "Stargazer", "description": "Stargazer", @@ -68596,8 +68882,6 @@ "value": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { - "MD5_RSA": "16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48", - "MD5_DSA": "ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c", "SHA256_RSA": "nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8", "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ" }, @@ -80605,6 +80889,100 @@ } } }, + "secret-scanning-alert-list": { + "value": [ + { + "number": 2, + "created_at": "2020-11-06T18:48:51Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", + "state": "resolved", + "resolution": "false_positive", + "resolved_at": "2020-11-07T02:47:13Z", + "resolved_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "secret_type": "adafruit_io_key", + "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX" + }, + { + "number": 1, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", + "html_url": "https://github.com/owner/repo/security/secret-scanning/1", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" + } + ] + }, + "secret-scanning-alert-open": { + "value": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" + } + }, + "secret-scanning-alert-resolved": { + "value": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", + "state": "resolved", + "resolution": "used_in_tests", + "resolved_at": "2020-11-16T22:42:07Z", + "resolved_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" + } + }, "simple-user-items-default-response": { "summary": "Default response", "value": [ @@ -84807,10 +85185,10 @@ "alert_number": { "name": "alert_number", "in": "path", - "description": "The code scanning alert number.", + "description": "The security alert number, found at the end of the security alert's URL.", "required": true, "schema": { - "$ref": "#/components/schemas/code-scanning-alert-number" + "$ref": "#/components/schemas/alert-number" } }, "commit_sha": { diff --git a/cache/ghes-2.18.deref.json b/cache/ghes-2.18.deref.json index 01ab65138..476aa57a3 100644 --- a/cache/ghes-2.18.deref.json +++ b/cache/ghes-2.18.deref.json @@ -119,6 +119,10 @@ "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." @@ -111072,7 +111076,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -111293,7 +111297,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" } }, "required": [ @@ -111412,7 +111416,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -111764,7 +111768,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -112101,7 +112105,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", diff --git a/cache/ghes-2.18.json b/cache/ghes-2.18.json index 2ca569008..1c2118e6b 100644 --- a/cache/ghes-2.18.json +++ b/cache/ghes-2.18.json @@ -119,6 +119,10 @@ "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." @@ -18885,7 +18889,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" } }, "required": [ @@ -47325,7 +47329,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "$ref": "#/components/schemas/webhook-config-secret" diff --git a/cache/ghes-2.19.deref.json b/cache/ghes-2.19.deref.json index 7c5237297..24c6a057f 100644 --- a/cache/ghes-2.19.deref.json +++ b/cache/ghes-2.19.deref.json @@ -119,6 +119,10 @@ "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." @@ -114248,7 +114252,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -114469,7 +114473,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" } }, "required": [ @@ -114588,7 +114592,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -114940,7 +114944,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -115277,7 +115281,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", diff --git a/cache/ghes-2.19.json b/cache/ghes-2.19.json index 30fa21b14..a37ddb051 100644 --- a/cache/ghes-2.19.json +++ b/cache/ghes-2.19.json @@ -119,6 +119,10 @@ "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." @@ -19340,7 +19344,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" } }, "required": [ @@ -47798,7 +47802,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "$ref": "#/components/schemas/webhook-config-secret" diff --git a/cache/ghes-2.20.deref.json b/cache/ghes-2.20.deref.json index a37d9befa..7e7bac75e 100644 --- a/cache/ghes-2.20.deref.json +++ b/cache/ghes-2.20.deref.json @@ -119,6 +119,10 @@ "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." @@ -115465,7 +115469,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -115686,7 +115690,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" } }, "required": [ @@ -115805,7 +115809,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -116157,7 +116161,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -116494,7 +116498,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", diff --git a/cache/ghes-2.20.json b/cache/ghes-2.20.json index df84ba61b..45ca16ac1 100644 --- a/cache/ghes-2.20.json +++ b/cache/ghes-2.20.json @@ -119,6 +119,10 @@ "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." @@ -19626,7 +19630,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" } }, "required": [ @@ -47802,7 +47806,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "$ref": "#/components/schemas/webhook-config-secret" diff --git a/cache/ghes-2.21.deref.json b/cache/ghes-2.21.deref.json index 8dfd19dc0..1c3be8a44 100644 --- a/cache/ghes-2.21.deref.json +++ b/cache/ghes-2.21.deref.json @@ -119,6 +119,10 @@ "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." @@ -124725,7 +124729,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -124946,7 +124950,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" } }, "required": [ @@ -125065,7 +125069,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -125417,7 +125421,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -125754,7 +125758,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", diff --git a/cache/ghes-2.21.json b/cache/ghes-2.21.json index b2793cf3f..b7dd51485 100644 --- a/cache/ghes-2.21.json +++ b/cache/ghes-2.21.json @@ -119,6 +119,10 @@ "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." @@ -21767,7 +21771,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" } }, "required": [ @@ -51296,7 +51300,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "$ref": "#/components/schemas/webhook-config-secret" diff --git a/cache/ghes-2.22.deref.json b/cache/ghes-2.22.deref.json index f86619072..b89d58412 100644 --- a/cache/ghes-2.22.deref.json +++ b/cache/ghes-2.22.deref.json @@ -119,6 +119,10 @@ "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." @@ -36376,12 +36380,6 @@ "ssh_key_fingerprints": { "type": "object", "properties": { - "MD5_RSA": { - "type": "string" - }, - "MD5_DSA": { - "type": "string" - }, "SHA256_RSA": { "type": "string" }, @@ -36463,8 +36461,6 @@ "value": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { - "MD5_RSA": "16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48", - "MD5_DSA": "ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c", "SHA256_RSA": "nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8", "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ" }, @@ -114834,7 +114830,7 @@ "properties": { "number": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false }, @@ -115198,7 +115194,7 @@ "properties": { "number": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false }, @@ -115586,11 +115582,11 @@ { "name": "alert_number", "in": "path", - "description": "The code scanning alert number.", + "description": "The security alert number, found at the end of the security alert's URL.", "required": true, "schema": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false } @@ -115651,7 +115647,7 @@ "properties": { "number": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false }, @@ -116200,6 +116196,12 @@ }, "404": { "description": "Response if `commit_sha` or `ref` cannot be found" + }, + "400": { + "description": "Response if the `sarif` field is invalid" + }, + "413": { + "description": "Response if the `sarif` field is too large" } }, "x-github": { @@ -145902,7 +145904,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -146123,7 +146125,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" } }, "required": [ @@ -146242,7 +146244,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -146594,7 +146596,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -146931,7 +146933,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", diff --git a/cache/ghes-2.22.json b/cache/ghes-2.22.json index 8d94d9db9..801884dcc 100644 --- a/cache/ghes-2.22.json +++ b/cache/ghes-2.22.json @@ -119,6 +119,10 @@ "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." @@ -21860,6 +21864,12 @@ }, "404": { "description": "Response if `commit_sha` or `ref` cannot be found" + }, + "400": { + "description": "Response if the `sarif` field is invalid" + }, + "413": { + "description": "Response if the `sarif` field is too large" } }, "x-github": { @@ -26202,7 +26212,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" } }, "required": [ @@ -44406,10 +44416,10 @@ "alert_number": { "name": "alert_number", "in": "path", - "description": "The code scanning alert number.", + "description": "The security alert number, found at the end of the security alert's URL.", "required": true, "schema": { - "$ref": "#/components/schemas/code-scanning-alert-number" + "$ref": "#/components/schemas/alert-number" } }, "commit_sha": { @@ -48811,12 +48821,6 @@ "ssh_key_fingerprints": { "type": "object", "properties": { - "MD5_RSA": { - "type": "string" - }, - "MD5_DSA": { - "type": "string" - }, "SHA256_RSA": { "type": "string" }, @@ -54131,27 +54135,27 @@ "type": "string", "description": "The full Git reference, formatted as `refs/heads/`." }, - "code-scanning-alert-number": { + "alert-number": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false }, - "code-scanning-alert-created-at": { + "alert-created-at": { "type": "string", "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true, "nullable": false }, - "code-scanning-alert-url": { + "alert-url": { "type": "string", "description": "The REST API URL of the alert resource.", "format": "uri", "readOnly": true, "nullable": false }, - "code-scanning-alert-html-url": { + "alert-html-url": { "type": "string", "description": "The GitHub URL of the alert resource.", "format": "uri", @@ -54230,16 +54234,16 @@ "type": "object", "properties": { "number": { - "$ref": "#/components/schemas/code-scanning-alert-number" + "$ref": "#/components/schemas/alert-number" }, "created_at": { - "$ref": "#/components/schemas/code-scanning-alert-created-at" + "$ref": "#/components/schemas/alert-created-at" }, "url": { - "$ref": "#/components/schemas/code-scanning-alert-url" + "$ref": "#/components/schemas/alert-url" }, "html_url": { - "$ref": "#/components/schemas/code-scanning-alert-html-url" + "$ref": "#/components/schemas/alert-html-url" }, "state": { "$ref": "#/components/schemas/code-scanning-alert-state" @@ -54297,16 +54301,16 @@ "type": "object", "properties": { "number": { - "$ref": "#/components/schemas/code-scanning-alert-number" + "$ref": "#/components/schemas/alert-number" }, "created_at": { - "$ref": "#/components/schemas/code-scanning-alert-created-at" + "$ref": "#/components/schemas/alert-created-at" }, "url": { - "$ref": "#/components/schemas/code-scanning-alert-url" + "$ref": "#/components/schemas/alert-url" }, "html_url": { - "$ref": "#/components/schemas/code-scanning-alert-html-url" + "$ref": "#/components/schemas/alert-html-url" }, "instances": { "$ref": "#/components/schemas/code-scanning-alert-instances" @@ -56809,7 +56813,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "$ref": "#/components/schemas/webhook-config-secret" @@ -64407,8 +64411,6 @@ "value": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { - "MD5_RSA": "16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48", - "MD5_DSA": "ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c", "SHA256_RSA": "nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8", "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ" }, diff --git a/cache/github.ae.deref.json b/cache/github.ae.deref.json index e3507503e..f72cf1c7b 100644 --- a/cache/github.ae.deref.json +++ b/cache/github.ae.deref.json @@ -119,6 +119,10 @@ "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." @@ -26866,12 +26870,6 @@ "ssh_key_fingerprints": { "type": "object", "properties": { - "MD5_RSA": { - "type": "string" - }, - "MD5_DSA": { - "type": "string" - }, "SHA256_RSA": { "type": "string" }, @@ -26953,8 +26951,6 @@ "value": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { - "MD5_RSA": "16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48", - "MD5_DSA": "ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c", "SHA256_RSA": "nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8", "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ" }, @@ -118887,7 +118883,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -119108,7 +119104,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" } }, "required": [ @@ -119227,7 +119223,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -119579,7 +119575,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", @@ -119916,7 +119912,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "type": "string", diff --git a/cache/github.ae.json b/cache/github.ae.json index e0976efed..d2ed88425 100644 --- a/cache/github.ae.json +++ b/cache/github.ae.json @@ -119,6 +119,10 @@ "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." @@ -20411,7 +20415,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" } }, "required": [ @@ -41581,12 +41585,6 @@ "ssh_key_fingerprints": { "type": "object", "properties": { - "MD5_RSA": { - "type": "string" - }, - "MD5_DSA": { - "type": "string" - }, "SHA256_RSA": { "type": "string" }, @@ -48702,7 +48700,7 @@ }, "digest": { "type": "string", - "example": "\"md5\"" + "example": "\"sha256\"" }, "secret": { "$ref": "#/components/schemas/webhook-config-secret" @@ -55348,8 +55346,6 @@ "value": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { - "MD5_RSA": "16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48", - "MD5_DSA": "ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c", "SHA256_RSA": "nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8", "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ" }, diff --git a/generated/api.github.com.deref.json b/generated/api.github.com.deref.json index 39dffd183..42ef52712 100644 --- a/generated/api.github.com.deref.json +++ b/generated/api.github.com.deref.json @@ -80,6 +80,10 @@ "description": "Provisioning of GitHub organization membership for SCIM-enabled providers." }, { "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." }, { "name": "users", @@ -28383,8 +28387,6 @@ "ssh_key_fingerprints": { "type": "object", "properties": { - "MD5_RSA": { "type": "string" }, - "MD5_DSA": { "type": "string" }, "SHA256_RSA": { "type": "string" }, "SHA256_DSA": { "type": "string" } } @@ -28432,8 +28434,6 @@ "value": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { - "MD5_RSA": "16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48", - "MD5_DSA": "ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c", "SHA256_RSA": "nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8", "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ" }, @@ -83363,7 +83363,7 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { "get": { "summary": "Get workflow run usage", - "description": "**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see \"[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage).\"\n\nGets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone 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.", + "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone 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.", "tags": ["actions"], "operationId": "actions/get-workflow-run-usage", "externalDocs": { @@ -85665,7 +85665,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { "get": { "summary": "Get workflow usage", - "description": "**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see \"[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage).\"\n\nGets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. 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.", + "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. 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.", "tags": ["actions"], "operationId": "actions/get-workflow-usage", "externalDocs": { @@ -101162,7 +101162,7 @@ "properties": { "number": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false }, @@ -101487,7 +101487,7 @@ "properties": { "number": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false }, @@ -101836,11 +101836,11 @@ { "name": "alert_number", "in": "path", - "description": "The code scanning alert number.", + "description": "The security alert number, found at the end of the security alert's URL.", "required": true, "schema": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false } @@ -101888,7 +101888,7 @@ "properties": { "number": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false }, @@ -102378,10 +102378,12 @@ }, "responses": { "202": { "description": "response" }, + "400": { "description": "Response if the `sarif` field is invalid" }, "403": { "description": "Response if the repository is archived" }, "404": { "description": "Response if `commit_sha` or `ref` cannot be found" - } + }, + "413": { "description": "Response if the `sarif` field is too large" } }, "x-github": { "enabledForGitHubApps": true, @@ -127404,7 +127406,10 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { + "type": "string", + "example": "\"sha256\"" + }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", @@ -127587,7 +127592,7 @@ "example": "\"0\"" }, "token": { "type": "string", "example": "\"abc\"" }, - "digest": { "type": "string", "example": "\"md5\"" } + "digest": { "type": "string", "example": "\"sha256\"" } }, "required": ["url"] }, @@ -127676,7 +127681,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", @@ -127944,7 +127949,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", @@ -128215,7 +128220,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", @@ -188420,6 +188425,871 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/secret-scanning/alerts": { + "get": { + "summary": "List secret scanning alerts for a repository", + "description": "Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "tags": ["secret-scanning"], + "operationId": "secret-scanning/list-alerts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + { + "name": "state", + "in": "query", + "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", + "required": false, + "schema": { "type": "string", "enum": ["open", "resolved"] } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { "type": "integer", "default": 1 } + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "query", + "schema": { "type": "integer", "default": 30 } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "state": { + "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", + "type": "string", + "enum": ["open", "resolved"] + }, + "resolution": { + "type": "string", + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`.", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests" + ] + }, + { "enum": [null] } + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { "type": "string", "example": "octocat" }, + "id": { "type": "integer", "example": 1 }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { "type": "string", "example": "User" }, + "site_admin": { "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "number": 2, + "created_at": "2020-11-06T18:48:51Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", + "state": "resolved", + "resolution": "false_positive", + "resolved_at": "2020-11-07T02:47:13Z", + "resolved_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "secret_type": "adafruit_io_key", + "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX" + }, + { + "number": 1, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", + "html_url": "https://github.com/owner/repo/security/secret-scanning/1", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" + } + ] + } + } + } + } + }, + "404": { + "description": "Repository is public or secret scanning is disabled for the repository" + }, + "503": { + "description": "Service Unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { "type": "string" }, + "message": { "type": "string" }, + "documentation_url": { "type": "string" } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "secret-scanning", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + "get": { + "summary": "Get a secret scanning alert", + "description": "Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "tags": ["secret-scanning"], + "operationId": "secret-scanning/get-alert", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/secret-scanning#get-a-secret-scanning-alert" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + { + "name": "alert_number", + "in": "path", + "description": "The security alert number, found at the end of the security alert's URL.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + } + } + ], + "responses": { + "200": { + "description": "Default response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "state": { + "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", + "type": "string", + "enum": ["open", "resolved"] + }, + "resolution": { + "type": "string", + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`.", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests" + ] + }, + { "enum": [null] } + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { "type": "string", "example": "octocat" }, + "id": { "type": "integer", "example": 1 }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { "type": "string", "example": "User" }, + "site_admin": { "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + } + } + }, + "examples": { + "default": { + "value": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" + } + } + } + } + } + }, + "404": { + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + "503": { + "description": "Service Unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { "type": "string" }, + "message": { "type": "string" }, + "documentation_url": { "type": "string" } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "secret-scanning", + "subcategory": null + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a secret scanning alert", + "description": "Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.", + "operationId": "secret-scanning/update-alert", + "tags": ["secret-scanning"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/secret-scanning#update-a-secret-scanning-alert" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + { + "name": "alert_number", + "in": "path", + "description": "The security alert number, found at the end of the security alert's URL.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", + "type": "string", + "enum": ["open", "resolved"] + }, + "resolution": { + "type": "string", + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`.", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests" + ] + }, + { "enum": [null] } + ] + } + }, + "required": ["state"] + }, + "example": { "state": "resolved", "resolution": "false_positive" } + } + } + }, + "responses": { + "200": { + "description": "Default response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "state": { + "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", + "type": "string", + "enum": ["open", "resolved"] + }, + "resolution": { + "type": "string", + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`.", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests" + ] + }, + { "enum": [null] } + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { "type": "string", "example": "octocat" }, + "id": { "type": "integer", "example": 1 }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { "type": "string", "example": "User" }, + "site_admin": { "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + } + } + }, + "examples": { + "default": { + "value": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", + "state": "resolved", + "resolution": "used_in_tests", + "resolved_at": "2020-11-16T22:42:07Z", + "resolved_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" + } + } + } + } + } + }, + "404": { + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + "422": { "description": "State does not match the resolution" }, + "503": { + "description": "Service Unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { "type": "string" }, + "message": { "type": "string" }, + "documentation_url": { "type": "string" } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "secret-scanning" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/stargazers": { "get": { "summary": "List stargazers", diff --git a/generated/api.github.com.json b/generated/api.github.com.json index 16349bb63..195c1ce0d 100644 --- a/generated/api.github.com.json +++ b/generated/api.github.com.json @@ -80,6 +80,10 @@ "description": "Provisioning of GitHub organization membership for SCIM-enabled providers." }, { "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." }, { "name": "users", @@ -13657,7 +13661,7 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { "get": { "summary": "Get workflow run usage", - "description": "**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see \"[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage).\"\n\nGets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone 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.", + "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone 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.", "tags": ["actions"], "operationId": "actions/get-workflow-run-usage", "externalDocs": { @@ -14151,7 +14155,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { "get": { "summary": "Get workflow usage", - "description": "**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see \"[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage).\"\n\nGets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. 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.", + "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. 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.", "tags": ["actions"], "operationId": "actions/get-workflow-usage", "externalDocs": { @@ -17347,10 +17351,12 @@ }, "responses": { "202": { "description": "response" }, + "400": { "description": "Response if the `sarif` field is invalid" }, "403": { "description": "Response if the repository is archived" }, "404": { "description": "Response if `commit_sha` or `ref` cannot be found" - } + }, + "413": { "description": "Response if the `sarif` field is too large" } }, "x-github": { "enabledForGitHubApps": true, @@ -20773,7 +20779,7 @@ "$ref": "#/components/schemas/webhook-config-insecure-ssl" }, "token": { "type": "string", "example": "\"abc\"" }, - "digest": { "type": "string", "example": "\"md5\"" } + "digest": { "type": "string", "example": "\"sha256\"" } }, "required": ["url"] }, @@ -27655,6 +27661,172 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/secret-scanning/alerts": { + "get": { + "summary": "List secret scanning alerts for a repository", + "description": "Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "tags": ["secret-scanning"], + "operationId": "secret-scanning/list-alerts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "state", + "in": "query", + "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", + "required": false, + "schema": { "type": "string", "enum": ["open", "resolved"] } + }, + { "$ref": "#/components/parameters/page" }, + { "$ref": "#/components/parameters/per_page" } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-alert" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-list" + } + } + } + } + }, + "404": { + "description": "Repository is public or secret scanning is disabled for the repository" + }, + "503": { "$ref": "#/components/responses/service_unavailable" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "secret-scanning", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + "get": { + "summary": "Get a secret scanning alert", + "description": "Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "tags": ["secret-scanning"], + "operationId": "secret-scanning/get-alert", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/secret-scanning#get-a-secret-scanning-alert" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/alert_number" } + ], + "responses": { + "200": { + "description": "Default response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-alert" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-open" + } + } + } + } + }, + "404": { + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + "503": { "$ref": "#/components/responses/service_unavailable" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "secret-scanning", + "subcategory": null + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a secret scanning alert", + "description": "Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.", + "operationId": "secret-scanning/update-alert", + "tags": ["secret-scanning"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/secret-scanning#update-a-secret-scanning-alert" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/alert_number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + } + }, + "required": ["state"] + }, + "example": { "state": "resolved", "resolution": "false_positive" } + } + } + }, + "responses": { + "200": { + "description": "Default response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-alert" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-resolved" + } + } + } + } + }, + "404": { + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + "422": { "description": "State does not match the resolution" }, + "503": { "$ref": "#/components/responses/service_unavailable" } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "secret-scanning" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/stargazers": { "get": { "summary": "List stargazers", @@ -39151,8 +39323,6 @@ "ssh_key_fingerprints": { "type": "object", "properties": { - "MD5_RSA": { "type": "string" }, - "MD5_DSA": { "type": "string" }, "SHA256_RSA": { "type": "string" }, "SHA256_DSA": { "type": "string" } } @@ -43238,27 +43408,27 @@ "type": "string", "description": "The full Git reference, formatted as `refs/heads/`." }, - "code-scanning-alert-number": { + "alert-number": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false }, - "code-scanning-alert-created-at": { + "alert-created-at": { "type": "string", "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true, "nullable": false }, - "code-scanning-alert-url": { + "alert-url": { "type": "string", "description": "The REST API URL of the alert resource.", "format": "uri", "readOnly": true, "nullable": false }, - "code-scanning-alert-html-url": { + "alert-html-url": { "type": "string", "description": "The GitHub URL of the alert resource.", "format": "uri", @@ -43321,16 +43491,10 @@ "code-scanning-alert-code-scanning-alert-items": { "type": "object", "properties": { - "number": { - "$ref": "#/components/schemas/code-scanning-alert-number" - }, - "created_at": { - "$ref": "#/components/schemas/code-scanning-alert-created-at" - }, - "url": { "$ref": "#/components/schemas/code-scanning-alert-url" }, - "html_url": { - "$ref": "#/components/schemas/code-scanning-alert-html-url" - }, + "number": { "$ref": "#/components/schemas/alert-number" }, + "created_at": { "$ref": "#/components/schemas/alert-created-at" }, + "url": { "$ref": "#/components/schemas/alert-url" }, + "html_url": { "$ref": "#/components/schemas/alert-html-url" }, "state": { "$ref": "#/components/schemas/code-scanning-alert-state" }, "dismissed_by": { "$ref": "#/components/schemas/simple-user" }, "dismissed_at": { @@ -43373,16 +43537,10 @@ "code-scanning-alert-code-scanning-alert": { "type": "object", "properties": { - "number": { - "$ref": "#/components/schemas/code-scanning-alert-number" - }, - "created_at": { - "$ref": "#/components/schemas/code-scanning-alert-created-at" - }, - "url": { "$ref": "#/components/schemas/code-scanning-alert-url" }, - "html_url": { - "$ref": "#/components/schemas/code-scanning-alert-html-url" - }, + "number": { "$ref": "#/components/schemas/alert-number" }, + "created_at": { "$ref": "#/components/schemas/alert-created-at" }, + "url": { "$ref": "#/components/schemas/alert-url" }, + "html_url": { "$ref": "#/components/schemas/alert-html-url" }, "instances": { "$ref": "#/components/schemas/code-scanning-alert-instances" }, @@ -45108,7 +45266,7 @@ "content_type": { "$ref": "#/components/schemas/webhook-config-content-type" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "$ref": "#/components/schemas/webhook-config-secret" }, @@ -47062,6 +47220,52 @@ "url" ] }, + "secret-scanning-alert-state": { + "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", + "type": "string", + "enum": ["open", "resolved"] + }, + "secret-scanning-alert-resolution": { + "type": "string", + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`.", + "nullable": true, + "oneOf": [ + { + "enum": ["false_positive", "wont_fix", "revoked", "used_in_tests"] + }, + { "enum": [null] } + ] + }, + "secret-scanning-alert": { + "type": "object", + "properties": { + "number": { "$ref": "#/components/schemas/alert-number" }, + "created_at": { "$ref": "#/components/schemas/alert-created-at" }, + "url": { "$ref": "#/components/schemas/alert-url" }, + "html_url": { "$ref": "#/components/schemas/alert-html-url" }, + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { "$ref": "#/components/schemas/simple-user" }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + } + } + }, "stargazer": { "title": "Stargazer", "description": "Stargazer", @@ -50369,8 +50573,6 @@ "value": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { - "MD5_RSA": "16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48", - "MD5_DSA": "ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c", "SHA256_RSA": "nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8", "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ" }, @@ -61952,6 +62154,100 @@ } } }, + "secret-scanning-alert-list": { + "value": [ + { + "number": 2, + "created_at": "2020-11-06T18:48:51Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", + "state": "resolved", + "resolution": "false_positive", + "resolved_at": "2020-11-07T02:47:13Z", + "resolved_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "secret_type": "adafruit_io_key", + "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX" + }, + { + "number": 1, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", + "html_url": "https://github.com/owner/repo/security/secret-scanning/1", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" + } + ] + }, + "secret-scanning-alert-open": { + "value": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" + } + }, + "secret-scanning-alert-resolved": { + "value": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", + "state": "resolved", + "resolution": "used_in_tests", + "resolved_at": "2020-11-16T22:42:07Z", + "resolved_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" + } + }, "simple-user-items-default-response": { "summary": "Default response", "value": [ @@ -65655,9 +65951,9 @@ "alert_number": { "name": "alert_number", "in": "path", - "description": "The code scanning alert number.", + "description": "The security alert number, found at the end of the security alert's URL.", "required": true, - "schema": { "$ref": "#/components/schemas/code-scanning-alert-number" } + "schema": { "$ref": "#/components/schemas/alert-number" } }, "commit_sha": { "name": "commit_sha", diff --git a/generated/ghes-2.18.deref.json b/generated/ghes-2.18.deref.json index 0e3a78eb3..0491cc854 100644 --- a/generated/ghes-2.18.deref.json +++ b/generated/ghes-2.18.deref.json @@ -80,6 +80,10 @@ "description": "Provisioning of GitHub organization membership for SCIM-enabled providers." }, { "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." }, { "name": "users", @@ -90639,7 +90643,10 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { + "type": "string", + "example": "\"sha256\"" + }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).", @@ -90822,7 +90829,7 @@ "example": "\"0\"" }, "token": { "type": "string", "example": "\"abc\"" }, - "digest": { "type": "string", "example": "\"md5\"" } + "digest": { "type": "string", "example": "\"sha256\"" } }, "required": ["url"] }, @@ -90911,7 +90918,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).", @@ -91179,7 +91186,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).", @@ -91450,7 +91457,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).", diff --git a/generated/ghes-2.18.json b/generated/ghes-2.18.json index e6ffcea39..98ba2360e 100644 --- a/generated/ghes-2.18.json +++ b/generated/ghes-2.18.json @@ -80,6 +80,10 @@ "description": "Provisioning of GitHub organization membership for SCIM-enabled providers." }, { "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." }, { "name": "users", @@ -14660,7 +14664,7 @@ "$ref": "#/components/schemas/webhook-config-insecure-ssl" }, "token": { "type": "string", "example": "\"abc\"" }, - "digest": { "type": "string", "example": "\"md5\"" } + "digest": { "type": "string", "example": "\"sha256\"" } }, "required": ["url"] }, @@ -35276,7 +35280,7 @@ "content_type": { "$ref": "#/components/schemas/webhook-config-content-type" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "$ref": "#/components/schemas/webhook-config-secret" }, diff --git a/generated/ghes-2.19.deref.json b/generated/ghes-2.19.deref.json index a72449044..65753660c 100644 --- a/generated/ghes-2.19.deref.json +++ b/generated/ghes-2.19.deref.json @@ -80,6 +80,10 @@ "description": "Provisioning of GitHub organization membership for SCIM-enabled providers." }, { "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." }, { "name": "users", @@ -93215,7 +93219,10 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { + "type": "string", + "example": "\"sha256\"" + }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).", @@ -93398,7 +93405,7 @@ "example": "\"0\"" }, "token": { "type": "string", "example": "\"abc\"" }, - "digest": { "type": "string", "example": "\"md5\"" } + "digest": { "type": "string", "example": "\"sha256\"" } }, "required": ["url"] }, @@ -93487,7 +93494,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).", @@ -93755,7 +93762,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).", @@ -94026,7 +94033,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).", diff --git a/generated/ghes-2.19.json b/generated/ghes-2.19.json index e670e712b..1ba0995dc 100644 --- a/generated/ghes-2.19.json +++ b/generated/ghes-2.19.json @@ -80,6 +80,10 @@ "description": "Provisioning of GitHub organization membership for SCIM-enabled providers." }, { "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." }, { "name": "users", @@ -15003,7 +15007,7 @@ "$ref": "#/components/schemas/webhook-config-insecure-ssl" }, "token": { "type": "string", "example": "\"abc\"" }, - "digest": { "type": "string", "example": "\"md5\"" } + "digest": { "type": "string", "example": "\"sha256\"" } }, "required": ["url"] }, @@ -35560,7 +35564,7 @@ "content_type": { "$ref": "#/components/schemas/webhook-config-content-type" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "$ref": "#/components/schemas/webhook-config-secret" }, diff --git a/generated/ghes-2.20.deref.json b/generated/ghes-2.20.deref.json index 5530b2991..785d82505 100644 --- a/generated/ghes-2.20.deref.json +++ b/generated/ghes-2.20.deref.json @@ -80,6 +80,10 @@ "description": "Provisioning of GitHub organization membership for SCIM-enabled providers." }, { "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." }, { "name": "users", @@ -94697,7 +94701,10 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { + "type": "string", + "example": "\"sha256\"" + }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.20/webhooks/event-payloads/#delivery-headers).", @@ -94880,7 +94887,7 @@ "example": "\"0\"" }, "token": { "type": "string", "example": "\"abc\"" }, - "digest": { "type": "string", "example": "\"md5\"" } + "digest": { "type": "string", "example": "\"sha256\"" } }, "required": ["url"] }, @@ -94969,7 +94976,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.20/webhooks/event-payloads/#delivery-headers).", @@ -95237,7 +95244,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.20/webhooks/event-payloads/#delivery-headers).", @@ -95508,7 +95515,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.20/webhooks/event-payloads/#delivery-headers).", diff --git a/generated/ghes-2.20.json b/generated/ghes-2.20.json index d2c7160b9..ffe83fb5b 100644 --- a/generated/ghes-2.20.json +++ b/generated/ghes-2.20.json @@ -80,6 +80,10 @@ "description": "Provisioning of GitHub organization membership for SCIM-enabled providers." }, { "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." }, { "name": "users", @@ -15220,7 +15224,7 @@ "$ref": "#/components/schemas/webhook-config-insecure-ssl" }, "token": { "type": "string", "example": "\"abc\"" }, - "digest": { "type": "string", "example": "\"md5\"" } + "digest": { "type": "string", "example": "\"sha256\"" } }, "required": ["url"] }, @@ -35637,7 +35641,7 @@ "content_type": { "$ref": "#/components/schemas/webhook-config-content-type" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "$ref": "#/components/schemas/webhook-config-secret" }, diff --git a/generated/ghes-2.21.deref.json b/generated/ghes-2.21.deref.json index a1a3da92f..ec8c2812b 100644 --- a/generated/ghes-2.21.deref.json +++ b/generated/ghes-2.21.deref.json @@ -80,6 +80,10 @@ "description": "Provisioning of GitHub organization membership for SCIM-enabled providers." }, { "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." }, { "name": "users", @@ -102523,7 +102527,10 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { + "type": "string", + "example": "\"sha256\"" + }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.21/webhooks/event-payloads/#delivery-headers).", @@ -102706,7 +102713,7 @@ "example": "\"0\"" }, "token": { "type": "string", "example": "\"abc\"" }, - "digest": { "type": "string", "example": "\"md5\"" } + "digest": { "type": "string", "example": "\"sha256\"" } }, "required": ["url"] }, @@ -102795,7 +102802,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.21/webhooks/event-payloads/#delivery-headers).", @@ -103063,7 +103070,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.21/webhooks/event-payloads/#delivery-headers).", @@ -103334,7 +103341,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.21/webhooks/event-payloads/#delivery-headers).", diff --git a/generated/ghes-2.21.json b/generated/ghes-2.21.json index a2afd75c2..acda26bff 100644 --- a/generated/ghes-2.21.json +++ b/generated/ghes-2.21.json @@ -80,6 +80,10 @@ "description": "Provisioning of GitHub organization membership for SCIM-enabled providers." }, { "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." }, { "name": "users", @@ -16855,7 +16859,7 @@ "$ref": "#/components/schemas/webhook-config-insecure-ssl" }, "token": { "type": "string", "example": "\"abc\"" }, - "digest": { "type": "string", "example": "\"md5\"" } + "digest": { "type": "string", "example": "\"sha256\"" } }, "required": ["url"] }, @@ -38208,7 +38212,7 @@ "content_type": { "$ref": "#/components/schemas/webhook-config-content-type" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "$ref": "#/components/schemas/webhook-config-secret" }, diff --git a/generated/ghes-2.22.deref.json b/generated/ghes-2.22.deref.json index a59c3be94..6a511c9e8 100644 --- a/generated/ghes-2.22.deref.json +++ b/generated/ghes-2.22.deref.json @@ -80,6 +80,10 @@ "description": "Provisioning of GitHub organization membership for SCIM-enabled providers." }, { "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." }, { "name": "users", @@ -29387,8 +29391,6 @@ "ssh_key_fingerprints": { "type": "object", "properties": { - "MD5_RSA": { "type": "string" }, - "MD5_DSA": { "type": "string" }, "SHA256_RSA": { "type": "string" }, "SHA256_DSA": { "type": "string" } } @@ -29436,8 +29438,6 @@ "value": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { - "MD5_RSA": "16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48", - "MD5_DSA": "ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c", "SHA256_RSA": "nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8", "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ" }, @@ -93598,7 +93598,7 @@ "properties": { "number": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false }, @@ -93923,7 +93923,7 @@ "properties": { "number": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false }, @@ -94272,11 +94272,11 @@ { "name": "alert_number", "in": "path", - "description": "The code scanning alert number.", + "description": "The security alert number, found at the end of the security alert's URL.", "required": true, "schema": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false } @@ -94324,7 +94324,7 @@ "properties": { "number": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false }, @@ -94814,10 +94814,12 @@ }, "responses": { "202": { "description": "response" }, + "400": { "description": "Response if the `sarif` field is invalid" }, "403": { "description": "Response if the repository is archived" }, "404": { "description": "Response if `commit_sha` or `ref` cannot be found" - } + }, + "413": { "description": "Response if the `sarif` field is too large" } }, "x-github": { "enabledForGitHubApps": true, @@ -119473,7 +119475,10 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { + "type": "string", + "example": "\"sha256\"" + }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads/#delivery-headers).", @@ -119656,7 +119661,7 @@ "example": "\"0\"" }, "token": { "type": "string", "example": "\"abc\"" }, - "digest": { "type": "string", "example": "\"md5\"" } + "digest": { "type": "string", "example": "\"sha256\"" } }, "required": ["url"] }, @@ -119745,7 +119750,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads/#delivery-headers).", @@ -120013,7 +120018,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads/#delivery-headers).", @@ -120284,7 +120289,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads/#delivery-headers).", diff --git a/generated/ghes-2.22.json b/generated/ghes-2.22.json index c2c3928e5..9c72d2e1b 100644 --- a/generated/ghes-2.22.json +++ b/generated/ghes-2.22.json @@ -80,6 +80,10 @@ "description": "Provisioning of GitHub organization membership for SCIM-enabled providers." }, { "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." }, { "name": "users", @@ -16843,10 +16847,12 @@ }, "responses": { "202": { "description": "response" }, + "400": { "description": "Response if the `sarif` field is invalid" }, "403": { "description": "Response if the repository is archived" }, "404": { "description": "Response if `commit_sha` or `ref` cannot be found" - } + }, + "413": { "description": "Response if the `sarif` field is too large" } }, "x-github": { "enabledForGitHubApps": true, @@ -20190,7 +20196,7 @@ "$ref": "#/components/schemas/webhook-config-insecure-ssl" }, "token": { "type": "string", "example": "\"abc\"" }, - "digest": { "type": "string", "example": "\"md5\"" } + "digest": { "type": "string", "example": "\"sha256\"" } }, "required": ["url"] }, @@ -33911,9 +33917,9 @@ "alert_number": { "name": "alert_number", "in": "path", - "description": "The code scanning alert number.", + "description": "The security alert number, found at the end of the security alert's URL.", "required": true, - "schema": { "$ref": "#/components/schemas/code-scanning-alert-number" } + "schema": { "$ref": "#/components/schemas/alert-number" } }, "commit_sha": { "name": "commit_sha", @@ -36778,8 +36784,6 @@ "ssh_key_fingerprints": { "type": "object", "properties": { - "MD5_RSA": { "type": "string" }, - "MD5_DSA": { "type": "string" }, "SHA256_RSA": { "type": "string" }, "SHA256_DSA": { "type": "string" } } @@ -40563,27 +40567,27 @@ "type": "string", "description": "The full Git reference, formatted as `refs/heads/`." }, - "code-scanning-alert-number": { + "alert-number": { "type": "integer", - "description": "The code scanning alert number.", + "description": "The security alert number.", "readOnly": true, "nullable": false }, - "code-scanning-alert-created-at": { + "alert-created-at": { "type": "string", "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true, "nullable": false }, - "code-scanning-alert-url": { + "alert-url": { "type": "string", "description": "The REST API URL of the alert resource.", "format": "uri", "readOnly": true, "nullable": false }, - "code-scanning-alert-html-url": { + "alert-html-url": { "type": "string", "description": "The GitHub URL of the alert resource.", "format": "uri", @@ -40646,16 +40650,10 @@ "code-scanning-alert-code-scanning-alert-items": { "type": "object", "properties": { - "number": { - "$ref": "#/components/schemas/code-scanning-alert-number" - }, - "created_at": { - "$ref": "#/components/schemas/code-scanning-alert-created-at" - }, - "url": { "$ref": "#/components/schemas/code-scanning-alert-url" }, - "html_url": { - "$ref": "#/components/schemas/code-scanning-alert-html-url" - }, + "number": { "$ref": "#/components/schemas/alert-number" }, + "created_at": { "$ref": "#/components/schemas/alert-created-at" }, + "url": { "$ref": "#/components/schemas/alert-url" }, + "html_url": { "$ref": "#/components/schemas/alert-html-url" }, "state": { "$ref": "#/components/schemas/code-scanning-alert-state" }, "dismissed_by": { "$ref": "#/components/schemas/simple-user" }, "dismissed_at": { @@ -40698,16 +40696,10 @@ "code-scanning-alert-code-scanning-alert": { "type": "object", "properties": { - "number": { - "$ref": "#/components/schemas/code-scanning-alert-number" - }, - "created_at": { - "$ref": "#/components/schemas/code-scanning-alert-created-at" - }, - "url": { "$ref": "#/components/schemas/code-scanning-alert-url" }, - "html_url": { - "$ref": "#/components/schemas/code-scanning-alert-html-url" - }, + "number": { "$ref": "#/components/schemas/alert-number" }, + "created_at": { "$ref": "#/components/schemas/alert-created-at" }, + "url": { "$ref": "#/components/schemas/alert-url" }, + "html_url": { "$ref": "#/components/schemas/alert-html-url" }, "instances": { "$ref": "#/components/schemas/code-scanning-alert-instances" }, @@ -42329,7 +42321,7 @@ "content_type": { "$ref": "#/components/schemas/webhook-config-content-type" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "$ref": "#/components/schemas/webhook-config-secret" }, @@ -47468,8 +47460,6 @@ "value": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { - "MD5_RSA": "16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48", - "MD5_DSA": "ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c", "SHA256_RSA": "nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8", "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ" }, diff --git a/generated/github.ae.deref.json b/generated/github.ae.deref.json index 87154485a..157c99f58 100644 --- a/generated/github.ae.deref.json +++ b/generated/github.ae.deref.json @@ -80,6 +80,10 @@ "description": "Provisioning of GitHub organization membership for SCIM-enabled providers." }, { "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." }, { "name": "users", @@ -21676,8 +21680,6 @@ "ssh_key_fingerprints": { "type": "object", "properties": { - "MD5_RSA": { "type": "string" }, - "MD5_DSA": { "type": "string" }, "SHA256_RSA": { "type": "string" }, "SHA256_DSA": { "type": "string" } } @@ -21725,8 +21727,6 @@ "value": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { - "MD5_RSA": "16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48", - "MD5_DSA": "ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c", "SHA256_RSA": "nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8", "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ" }, @@ -97559,7 +97559,10 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { + "type": "string", + "example": "\"sha256\"" + }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", @@ -97742,7 +97745,7 @@ "example": "\"0\"" }, "token": { "type": "string", "example": "\"abc\"" }, - "digest": { "type": "string", "example": "\"md5\"" } + "digest": { "type": "string", "example": "\"sha256\"" } }, "required": ["url"] }, @@ -97831,7 +97834,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", @@ -98099,7 +98102,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", @@ -98370,7 +98373,7 @@ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", diff --git a/generated/github.ae.json b/generated/github.ae.json index d4a58ba3c..523f4b23d 100644 --- a/generated/github.ae.json +++ b/generated/github.ae.json @@ -80,6 +80,10 @@ "description": "Provisioning of GitHub organization membership for SCIM-enabled providers." }, { "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, { "name": "teams", "description": "Interact with GitHub Teams." }, { "name": "users", @@ -15687,7 +15691,7 @@ "$ref": "#/components/schemas/webhook-config-insecure-ssl" }, "token": { "type": "string", "example": "\"abc\"" }, - "digest": { "type": "string", "example": "\"md5\"" } + "digest": { "type": "string", "example": "\"sha256\"" } }, "required": ["url"] }, @@ -31242,8 +31246,6 @@ "ssh_key_fingerprints": { "type": "object", "properties": { - "MD5_RSA": { "type": "string" }, - "MD5_DSA": { "type": "string" }, "SHA256_RSA": { "type": "string" }, "SHA256_DSA": { "type": "string" } } @@ -36084,7 +36086,7 @@ "content_type": { "$ref": "#/components/schemas/webhook-config-content-type" }, - "digest": { "type": "string", "example": "\"md5\"" }, + "digest": { "type": "string", "example": "\"sha256\"" }, "secret": { "$ref": "#/components/schemas/webhook-config-secret" }, @@ -40557,8 +40559,6 @@ "value": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { - "MD5_RSA": "16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48", - "MD5_DSA": "ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c", "SHA256_RSA": "nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8", "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ" },