CodeQL languages to be analyzed. Supported values are: c-cpp, csharp, go, java-kotlin, javascript-typescript, python, and ruby.
CodeQL languages to be analyzed. Supported values are: c-cpp, csharp, go, java-kotlin, javascript-typescript, python, ruby, and swift.
Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces billing permissions for users according to the visibility.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Codespaces for the specified users will be billed to the organization.
\nTo use this endpoint, the billing settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"
You must authenticate using an access token with the admin:org scope to use this endpoint.
Codespaces for the specified users will be billed to the organization.
\nTo use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"
You must authenticate using an access token with the admin:org scope to use this endpoint.
Codespaces for the specified users will no longer be billed to the organization.
\nTo use this endpoint, the billing settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"
You must authenticate using an access token with the admin:org scope to use this endpoint.
Codespaces for the specified users will no longer be billed to the organization.
\nTo use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"
You must authenticate using an access token with the admin:org scope to use this endpoint.
The level at which the comment is targeted.
", "enum": [ - "LINE", - "FILE" + "line", + "file" ] } ], @@ -499357,6 +499357,1475 @@ ] }, "security-advisories": { + "global-advisories": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/advisories", + "title": "List global security advisories", + "category": "security-advisories", + "subcategory": "global-advisories", + "parameters": [ + { + "name": "ghsa_id", + "in": "query", + "description": "If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.
", + "schema": { + "type": "string" + } + }, + { + "name": "type", + "in": "query", + "description": "If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware.
", + "schema": { + "type": "string", + "enum": [ + "reviewed", + "malware", + "unreviewed" + ], + "default": "reviewed" + } + }, + { + "name": "cve_id", + "description": "If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.
", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "ecosystem", + "in": "query", + "description": "If specified, only advisories for these ecosystems will be returned.
", + "schema": { + "type": "string", + "enum": [ + "actions", + "composer", + "erlang", + "go", + "maven", + "npm", + "nuget", + "other", + "pip", + "pub", + "rubygems", + "rust" + ] + } + }, + { + "name": "severity", + "in": "query", + "description": "If specified, only advisories with these severities will be returned.
", + "schema": { + "type": "string", + "enum": [ + "unknown", + "low", + "medium", + "high", + "critical" + ] + } + }, + { + "name": "cwes", + "in": "query", + "description": "If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.
", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + }, + { + "name": "is_withdrawn", + "in": "query", + "description": "Whether to only return advisories that have been withdrawn.
", + "schema": { + "type": "boolean" + } + }, + { + "name": "affects", + "in": "query", + "description": "If specified, return advisories that affect any of package or package@version. A maximum of 1000 packages can be specified. If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.
If specified, only return advisories that were published on a date or date range.
\nFor more information on the syntax of the date range, see \"Understanding the search syntax.\"
", + "schema": { + "type": "string" + } + }, + { + "name": "updated", + "in": "query", + "description": "If specified, only return advisories that were updated on a date or date range.
\nFor more information on the syntax of the date range, see \"Understanding the search syntax.\"
", + "schema": { + "type": "string" + } + }, + { + "name": "modified", + "description": "If specified, only show advisories that were updated or published on a date or date range.
\nFor more information on the syntax of the date range, see \"Understanding the search syntax.\"
", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "sort", + "description": "The property to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "updated", + "published" + ], + "default": "published" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "id": 1, + "ghsa_id": "GHSA-abcd-1234-efgh", + "cve_id": "CVE-2050-00000", + "url": "https://api.github.com/advisories/GHSA-abcd-1234-efgh", + "html_url": "https://github.com/advisories/GHSA-abcd-1234-efgh", + "repository_advisory_url": "https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh", + "summary": "Heartbleed security advisory", + "description": "This bug allows an attacker to read portions of the affected server’s memory, potentially disclosing sensitive information.", + "type": "reviewed", + "severity": "high", + "source_code_location": "https://github.com/project/a-package", + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-abcd-1234-efgh" + }, + { + "type": "CVE", + "value": "CVE-2050-00000" + } + ], + "references": [ + "https://nvd.nist.gov/vuln/detail/CVE-2050-00000" + ], + "published_at": "2023-03-23T02:30:56Z", + "updated_at": "2023-03-24T02:30:56Z", + "github_reviewed_at": "2023-03-23T02:30:56Z", + "nvd_published_at": "2023-03-25T02:30:56Z", + "withdrawn_at": null, + "vulnerabilities": [ + { + "package": { + "ecosystem": "npm", + "name": "a-package" + }, + "first_patched_version": "1.0.3", + "vulnerable_version_range": "<=1.0.2", + "vulnerable_functions": [ + "a_function" + ] + } + ], + "cvss": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cwes": [ + { + "cwe_id": "CWE-400", + "name": "Uncontrolled Resource Consumption" + } + ], + "credits": [ + { + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "type": "analyst" + } + ] + } + ], + "schema": { + "type": "array", + "items": { + "description": "A GitHub Security Advisory.", + "type": "object", + "properties": { + "ghsa_id": { + "type": "string", + "description": "The GitHub Security Advisory ID.", + "readOnly": true + }, + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The Common Vulnerabilities and Exposures (CVE) ID.", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The API URL for the advisory.", + "readOnly": true + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL for the advisory.", + "readOnly": true + }, + "repository_advisory_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The API URL for the repository advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short summary of the advisory.", + "maxLength": 1024 + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A detailed description of what the advisory entails.", + "maxLength": 65535 + }, + "type": { + "type": "string", + "description": "The type of advisory.", + "readOnly": true, + "enum": [ + "reviewed", + "unreviewed", + "malware" + ] + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "enum": [ + "critical", + "high", + "medium", + "low", + "unknown" + ] + }, + "source_code_location": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL of the advisory's source code." + }, + "identifiers": { + "type": [ + "array", + "null" + ], + "readOnly": true, + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + } + }, + "references": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "description": "URLs with more information regarding the advisory." + } + }, + "published_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true + }, + "github_reviewed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.", + "readOnly": true + }, + "nvd_published_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was published in the National Vulnerability Database, in ISO 8601 format.", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true + }, + "vulnerabilities": { + "type": [ + "array", + "null" + ], + "description": "The products and respective version ranges affected by the advisory.", + "items": { + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": [ + "object", + "null" + ], + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other", + "swift" + ] + }, + "name": { + "type": [ + "string", + "null" + ], + "description": "The unique package name within its ecosystem." + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": [ + "string", + "null" + ], + "description": "The range of the package versions affected by the vulnerability." + }, + "first_patched_version": { + "type": [ + "string", + "null" + ], + "description": "The package version that resolve the vulnerability." + }, + "vulnerable_functions": { + "type": [ + "array", + "null" + ], + "description": "The functions in the package that are affected by the vulnerability.", + "readOnly": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "first_patched_version", + "vulnerable_functions" + ] + } + }, + "cvss": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS vector." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cwes": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string", + "description": "The Common Weakness Enumeration (CWE) identifier." + }, + "name": { + "type": "string", + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + } + }, + "credits": { + "type": [ + "array", + "null" + ], + "readOnly": true, + "items": { + "type": "object", + "properties": { + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"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" + ] + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + } + }, + "required": [ + "user", + "type" + ] + } + } + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "repository_advisory_url", + "summary", + "description", + "type", + "severity", + "source_code_location", + "identifiers", + "references", + "published_at", + "updated_at", + "github_reviewed_at", + "nvd_published_at", + "withdrawn_at", + "vulnerabilities", + "cvss", + "cwes", + "credits" + ], + "additionalProperties": false + } + } + } + } + ], + "previews": [], + "descriptionHTML": "List global security advisories and filter using parameters such as ecosystem, GHSA ID, CVE ID, etc.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "429", + "description": "Too many requests
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/advisories/{ghsa_id}", + "title": "Get a global security advisory", + "category": "security-advisories", + "subcategory": "global-advisories", + "parameters": [ + { + "name": "ghsa_id", + "description": "The GHSA (GitHub Security Advisory) identifier of the advisory.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "ghsa_id": "GHSA_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "ghsa_id": "GHSA-abcd-1234-efgh", + "cve_id": "CVE-2050-00000", + "url": "https://api.github.com/advisories/GHSA-abcd-1234-efgh", + "html_url": "https://github.com/advisories/GHSA-abcd-1234-efgh", + "repository_advisory_url": "https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh", + "summary": "A short summary of the advisory.", + "description": "A detailed description of what the advisory entails.", + "type": "reviewed", + "severity": "high", + "source_code_location": "https://github.com/project/a-package", + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-abcd-1234-efgh" + }, + { + "type": "CVE", + "value": "CVE-2050-00000" + } + ], + "references": [ + "https://nvd.nist.gov/vuln/detail/CVE-2050-00000" + ], + "published_at": "2023-03-23T02:30:56Z", + "updated_at": "2023-03-24T02:30:56Z", + "github_reviewed_at": "2023-03-23T02:30:56Z", + "nvd_published_at": "2023-03-25T02:30:56Z", + "withdrawn_at": null, + "vulnerabilities": [ + { + "package": { + "ecosystem": "npm", + "name": "a-package" + }, + "first_patched_version": "1.0.3", + "vulnerable_version_range": "<=1.0.2", + "vulnerable_functions": [ + "a_function" + ] + } + ], + "cvss": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cwes": [ + { + "cwe_id": "CWE-400", + "name": "Uncontrolled Resource Consumption" + } + ], + "credits": [ + { + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "type": "analyst" + } + ] + }, + "schema": { + "description": "A GitHub Security Advisory.", + "type": "object", + "properties": { + "ghsa_id": { + "type": "string", + "description": "The GitHub Security Advisory ID.", + "readOnly": true + }, + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The Common Vulnerabilities and Exposures (CVE) ID.", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The API URL for the advisory.", + "readOnly": true + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL for the advisory.", + "readOnly": true + }, + "repository_advisory_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The API URL for the repository advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short summary of the advisory.", + "maxLength": 1024 + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A detailed description of what the advisory entails.", + "maxLength": 65535 + }, + "type": { + "type": "string", + "description": "The type of advisory.", + "readOnly": true, + "enum": [ + "reviewed", + "unreviewed", + "malware" + ] + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "enum": [ + "critical", + "high", + "medium", + "low", + "unknown" + ] + }, + "source_code_location": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL of the advisory's source code." + }, + "identifiers": { + "type": [ + "array", + "null" + ], + "readOnly": true, + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + } + }, + "references": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "description": "URLs with more information regarding the advisory." + } + }, + "published_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true + }, + "github_reviewed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.", + "readOnly": true + }, + "nvd_published_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was published in the National Vulnerability Database, in ISO 8601 format.", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true + }, + "vulnerabilities": { + "type": [ + "array", + "null" + ], + "description": "The products and respective version ranges affected by the advisory.", + "items": { + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": [ + "object", + "null" + ], + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other", + "swift" + ] + }, + "name": { + "type": [ + "string", + "null" + ], + "description": "The unique package name within its ecosystem." + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": [ + "string", + "null" + ], + "description": "The range of the package versions affected by the vulnerability." + }, + "first_patched_version": { + "type": [ + "string", + "null" + ], + "description": "The package version that resolve the vulnerability." + }, + "vulnerable_functions": { + "type": [ + "array", + "null" + ], + "description": "The functions in the package that are affected by the vulnerability.", + "readOnly": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "first_patched_version", + "vulnerable_functions" + ] + } + }, + "cvss": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS vector." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cwes": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string", + "description": "The Common Weakness Enumeration (CWE) identifier." + }, + "name": { + "type": "string", + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + } + }, + "credits": { + "type": [ + "array", + "null" + ], + "readOnly": true, + "items": { + "type": "object", + "properties": { + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"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" + ] + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + } + }, + "required": [ + "user", + "type" + ] + } + } + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "repository_advisory_url", + "summary", + "description", + "type", + "severity", + "source_code_location", + "identifiers", + "references", + "published_at", + "updated_at", + "github_reviewed_at", + "nvd_published_at", + "withdrawn_at", + "vulnerabilities", + "cvss", + "cwes", + "credits" + ], + "additionalProperties": false + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + } + ], "repository-advisories": [ { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 4158879d46..88b5bc222d 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -164301,7 +164301,7 @@ "type": "array of strings", "name": "languages", "in": "body", - "description": "CodeQL languages to be analyzed. Supported values are: c-cpp, csharp, go, java-kotlin, javascript-typescript, python, and ruby.
CodeQL languages to be analyzed. Supported values are: c-cpp, csharp, go, java-kotlin, javascript-typescript, python, ruby, and swift.
Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces billing permissions for users according to the visibility.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Codespaces for the specified users will be billed to the organization.
\nTo use this endpoint, the billing settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"
You must authenticate using an access token with the admin:org scope to use this endpoint.
Codespaces for the specified users will be billed to the organization.
\nTo use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"
You must authenticate using an access token with the admin:org scope to use this endpoint.
Codespaces for the specified users will no longer be billed to the organization.
\nTo use this endpoint, the billing settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"
You must authenticate using an access token with the admin:org scope to use this endpoint.
Codespaces for the specified users will no longer be billed to the organization.
\nTo use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"
You must authenticate using an access token with the admin:org scope to use this endpoint.
The level at which the comment is targeted.
", "enum": [ - "LINE", - "FILE" + "line", + "file" ] } ], @@ -518890,6 +518890,1475 @@ ] }, "security-advisories": { + "global-advisories": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/advisories", + "title": "List global security advisories", + "category": "security-advisories", + "subcategory": "global-advisories", + "parameters": [ + { + "name": "ghsa_id", + "in": "query", + "description": "If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.
", + "schema": { + "type": "string" + } + }, + { + "name": "type", + "in": "query", + "description": "If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware.
", + "schema": { + "type": "string", + "enum": [ + "reviewed", + "malware", + "unreviewed" + ], + "default": "reviewed" + } + }, + { + "name": "cve_id", + "description": "If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.
", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "ecosystem", + "in": "query", + "description": "If specified, only advisories for these ecosystems will be returned.
", + "schema": { + "type": "string", + "enum": [ + "actions", + "composer", + "erlang", + "go", + "maven", + "npm", + "nuget", + "other", + "pip", + "pub", + "rubygems", + "rust" + ] + } + }, + { + "name": "severity", + "in": "query", + "description": "If specified, only advisories with these severities will be returned.
", + "schema": { + "type": "string", + "enum": [ + "unknown", + "low", + "medium", + "high", + "critical" + ] + } + }, + { + "name": "cwes", + "in": "query", + "description": "If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.
", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + }, + { + "name": "is_withdrawn", + "in": "query", + "description": "Whether to only return advisories that have been withdrawn.
", + "schema": { + "type": "boolean" + } + }, + { + "name": "affects", + "in": "query", + "description": "If specified, return advisories that affect any of package or package@version. A maximum of 1000 packages can be specified. If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.
If specified, only return advisories that were published on a date or date range.
\nFor more information on the syntax of the date range, see \"Understanding the search syntax.\"
", + "schema": { + "type": "string" + } + }, + { + "name": "updated", + "in": "query", + "description": "If specified, only return advisories that were updated on a date or date range.
\nFor more information on the syntax of the date range, see \"Understanding the search syntax.\"
", + "schema": { + "type": "string" + } + }, + { + "name": "modified", + "description": "If specified, only show advisories that were updated or published on a date or date range.
\nFor more information on the syntax of the date range, see \"Understanding the search syntax.\"
", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "sort", + "description": "The property to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "updated", + "published" + ], + "default": "published" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "id": 1, + "ghsa_id": "GHSA-abcd-1234-efgh", + "cve_id": "CVE-2050-00000", + "url": "https://api.github.com/advisories/GHSA-abcd-1234-efgh", + "html_url": "https://github.com/advisories/GHSA-abcd-1234-efgh", + "repository_advisory_url": "https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh", + "summary": "Heartbleed security advisory", + "description": "This bug allows an attacker to read portions of the affected server’s memory, potentially disclosing sensitive information.", + "type": "reviewed", + "severity": "high", + "source_code_location": "https://github.com/project/a-package", + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-abcd-1234-efgh" + }, + { + "type": "CVE", + "value": "CVE-2050-00000" + } + ], + "references": [ + "https://nvd.nist.gov/vuln/detail/CVE-2050-00000" + ], + "published_at": "2023-03-23T02:30:56Z", + "updated_at": "2023-03-24T02:30:56Z", + "github_reviewed_at": "2023-03-23T02:30:56Z", + "nvd_published_at": "2023-03-25T02:30:56Z", + "withdrawn_at": null, + "vulnerabilities": [ + { + "package": { + "ecosystem": "npm", + "name": "a-package" + }, + "first_patched_version": "1.0.3", + "vulnerable_version_range": "<=1.0.2", + "vulnerable_functions": [ + "a_function" + ] + } + ], + "cvss": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cwes": [ + { + "cwe_id": "CWE-400", + "name": "Uncontrolled Resource Consumption" + } + ], + "credits": [ + { + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "type": "analyst" + } + ] + } + ], + "schema": { + "type": "array", + "items": { + "description": "A GitHub Security Advisory.", + "type": "object", + "properties": { + "ghsa_id": { + "type": "string", + "description": "The GitHub Security Advisory ID.", + "readOnly": true + }, + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The Common Vulnerabilities and Exposures (CVE) ID.", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The API URL for the advisory.", + "readOnly": true + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL for the advisory.", + "readOnly": true + }, + "repository_advisory_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The API URL for the repository advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short summary of the advisory.", + "maxLength": 1024 + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A detailed description of what the advisory entails.", + "maxLength": 65535 + }, + "type": { + "type": "string", + "description": "The type of advisory.", + "readOnly": true, + "enum": [ + "reviewed", + "unreviewed", + "malware" + ] + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "enum": [ + "critical", + "high", + "medium", + "low", + "unknown" + ] + }, + "source_code_location": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL of the advisory's source code." + }, + "identifiers": { + "type": [ + "array", + "null" + ], + "readOnly": true, + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + } + }, + "references": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "description": "URLs with more information regarding the advisory." + } + }, + "published_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true + }, + "github_reviewed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.", + "readOnly": true + }, + "nvd_published_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was published in the National Vulnerability Database, in ISO 8601 format.", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true + }, + "vulnerabilities": { + "type": [ + "array", + "null" + ], + "description": "The products and respective version ranges affected by the advisory.", + "items": { + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": [ + "object", + "null" + ], + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other", + "swift" + ] + }, + "name": { + "type": [ + "string", + "null" + ], + "description": "The unique package name within its ecosystem." + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": [ + "string", + "null" + ], + "description": "The range of the package versions affected by the vulnerability." + }, + "first_patched_version": { + "type": [ + "string", + "null" + ], + "description": "The package version that resolve the vulnerability." + }, + "vulnerable_functions": { + "type": [ + "array", + "null" + ], + "description": "The functions in the package that are affected by the vulnerability.", + "readOnly": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "first_patched_version", + "vulnerable_functions" + ] + } + }, + "cvss": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS vector." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cwes": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string", + "description": "The Common Weakness Enumeration (CWE) identifier." + }, + "name": { + "type": "string", + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + } + }, + "credits": { + "type": [ + "array", + "null" + ], + "readOnly": true, + "items": { + "type": "object", + "properties": { + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"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" + ] + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + } + }, + "required": [ + "user", + "type" + ] + } + } + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "repository_advisory_url", + "summary", + "description", + "type", + "severity", + "source_code_location", + "identifiers", + "references", + "published_at", + "updated_at", + "github_reviewed_at", + "nvd_published_at", + "withdrawn_at", + "vulnerabilities", + "cvss", + "cwes", + "credits" + ], + "additionalProperties": false + } + } + } + } + ], + "previews": [], + "descriptionHTML": "List global security advisories and filter using parameters such as ecosystem, GHSA ID, CVE ID, etc.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "429", + "description": "Too many requests
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/advisories/{ghsa_id}", + "title": "Get a global security advisory", + "category": "security-advisories", + "subcategory": "global-advisories", + "parameters": [ + { + "name": "ghsa_id", + "description": "The GHSA (GitHub Security Advisory) identifier of the advisory.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "ghsa_id": "GHSA_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "ghsa_id": "GHSA-abcd-1234-efgh", + "cve_id": "CVE-2050-00000", + "url": "https://api.github.com/advisories/GHSA-abcd-1234-efgh", + "html_url": "https://github.com/advisories/GHSA-abcd-1234-efgh", + "repository_advisory_url": "https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh", + "summary": "A short summary of the advisory.", + "description": "A detailed description of what the advisory entails.", + "type": "reviewed", + "severity": "high", + "source_code_location": "https://github.com/project/a-package", + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-abcd-1234-efgh" + }, + { + "type": "CVE", + "value": "CVE-2050-00000" + } + ], + "references": [ + "https://nvd.nist.gov/vuln/detail/CVE-2050-00000" + ], + "published_at": "2023-03-23T02:30:56Z", + "updated_at": "2023-03-24T02:30:56Z", + "github_reviewed_at": "2023-03-23T02:30:56Z", + "nvd_published_at": "2023-03-25T02:30:56Z", + "withdrawn_at": null, + "vulnerabilities": [ + { + "package": { + "ecosystem": "npm", + "name": "a-package" + }, + "first_patched_version": "1.0.3", + "vulnerable_version_range": "<=1.0.2", + "vulnerable_functions": [ + "a_function" + ] + } + ], + "cvss": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cwes": [ + { + "cwe_id": "CWE-400", + "name": "Uncontrolled Resource Consumption" + } + ], + "credits": [ + { + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "type": "analyst" + } + ] + }, + "schema": { + "description": "A GitHub Security Advisory.", + "type": "object", + "properties": { + "ghsa_id": { + "type": "string", + "description": "The GitHub Security Advisory ID.", + "readOnly": true + }, + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The Common Vulnerabilities and Exposures (CVE) ID.", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The API URL for the advisory.", + "readOnly": true + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL for the advisory.", + "readOnly": true + }, + "repository_advisory_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The API URL for the repository advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short summary of the advisory.", + "maxLength": 1024 + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A detailed description of what the advisory entails.", + "maxLength": 65535 + }, + "type": { + "type": "string", + "description": "The type of advisory.", + "readOnly": true, + "enum": [ + "reviewed", + "unreviewed", + "malware" + ] + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "enum": [ + "critical", + "high", + "medium", + "low", + "unknown" + ] + }, + "source_code_location": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL of the advisory's source code." + }, + "identifiers": { + "type": [ + "array", + "null" + ], + "readOnly": true, + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + } + }, + "references": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "description": "URLs with more information regarding the advisory." + } + }, + "published_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true + }, + "github_reviewed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.", + "readOnly": true + }, + "nvd_published_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was published in the National Vulnerability Database, in ISO 8601 format.", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true + }, + "vulnerabilities": { + "type": [ + "array", + "null" + ], + "description": "The products and respective version ranges affected by the advisory.", + "items": { + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": [ + "object", + "null" + ], + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other", + "swift" + ] + }, + "name": { + "type": [ + "string", + "null" + ], + "description": "The unique package name within its ecosystem." + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": [ + "string", + "null" + ], + "description": "The range of the package versions affected by the vulnerability." + }, + "first_patched_version": { + "type": [ + "string", + "null" + ], + "description": "The package version that resolve the vulnerability." + }, + "vulnerable_functions": { + "type": [ + "array", + "null" + ], + "description": "The functions in the package that are affected by the vulnerability.", + "readOnly": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "first_patched_version", + "vulnerable_functions" + ] + } + }, + "cvss": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS vector." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cwes": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string", + "description": "The Common Weakness Enumeration (CWE) identifier." + }, + "name": { + "type": "string", + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + } + }, + "credits": { + "type": [ + "array", + "null" + ], + "readOnly": true, + "items": { + "type": "object", + "properties": { + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"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" + ] + }, + "type": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + } + }, + "required": [ + "user", + "type" + ] + } + } + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "repository_advisory_url", + "summary", + "description", + "type", + "severity", + "source_code_location", + "identifiers", + "references", + "published_at", + "updated_at", + "github_reviewed_at", + "nvd_published_at", + "withdrawn_at", + "vulnerabilities", + "cvss", + "cwes", + "credits" + ], + "additionalProperties": false + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + } + ], "repository-advisories": [ { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/ghes-3.9-2022-11-28/schema.json b/src/rest/data/ghes-3.9-2022-11-28/schema.json index c8ea644a15..81a0e3eb98 100644 --- a/src/rest/data/ghes-3.9-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.9-2022-11-28/schema.json @@ -383403,8 +383403,8 @@ "in": "body", "description": "The level at which the comment is targeted.
", "enum": [ - "LINE", - "FILE" + "line", + "file" ] } ], diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index d7b47d540b..17a4a8b911 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -33,5 +33,5 @@ ] } }, - "sha": "8482a8d60da584a11eb150f7849ad78b2f58aadd" + "sha": "3be14a37ce061fe138c8a075e54e2bbeb7df2ac6" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 03a9b4802d..1d2052f0db 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -165803,24 +165803,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -165969,16 +165962,6 @@ "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" - }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -166218,24 +166201,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -166384,16 +166360,6 @@ "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" - }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -166596,423 +166562,6 @@ ], "childParamsGroups": [] }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub URL of the alert resource.
" - }, - { - "type": "string", - "name": "locations_url", - "description": "The REST API URL of the code locations for this alert.
" - }, - { - "type": "integer", - "name": "number", - "description": "The security alert number.
" - }, - { - "type": "boolean or null", - "name": "push_protection_bypassed", - "description": "Whether push protection was bypassed for the detected secret.
" - }, - { - "type": "string or null", - "name": "push_protection_bypassed_at", - "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "resolution", - "description": "Required when the state is resolved. The reason for resolving the alert.
The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "resolution_comment", - "description": "An optional comment to resolve an alert.
" - }, - { - "type": "string", - "name": "secret", - "description": "The secret that was detected.
" - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that secret scanning detected.
" - }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "An enterprise on GitHub.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "A GitHub organization.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "A repository on GitHub.
", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "resolved", - "category": "secret_scanning_alert" - }, - "revoked": { - "descriptionHtml": "A secret scanning alert was marked as revoked.
", - "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "revoked" - ], - "childParamsGroups": [] - }, { "type": "object", "name": "alert", @@ -167050,24 +166599,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -167217,14 +166759,402 @@ "description": "The type of secret that secret scanning detected.
" }, { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
Whether push protection was bypassed for the detected secret.
" + }, + { + "type": "object", + "name": "push_protection_bypassed_by", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypassed_at", + "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "resolved", + "category": "secret_scanning_alert" + }, + "revoked": { + "descriptionHtml": "A secret scanning alert was marked as revoked.
", + "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "revoked" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
" }, { "type": "string", - "name": "secret", - "description": "The secret that was detected.
" + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" + }, + { + "type": "string", + "name": "html_url", + "description": "The GitHub URL of the alert resource.
" + }, + { + "type": "string", + "name": "locations_url", + "description": "The REST API URL of the code locations for this alert.
" + }, + { + "type": "string or null", + "name": "resolution", + "description": "The reason for resolving the alert.
", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + { + "type": "string or null", + "name": "resolved_at", + "description": "The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "resolution_comment", + "description": "An optional comment to resolve an alert.
" + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that secret scanning detected.
" }, { "type": "boolean or null", @@ -167466,24 +167396,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -167632,16 +167555,6 @@ "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" - }, { "type": "boolean or null", "name": "push_protection_bypassed", diff --git a/src/webhooks/data/ghae/schema.json b/src/webhooks/data/ghae/schema.json index 83801294e0..b058486bb8 100644 --- a/src/webhooks/data/ghae/schema.json +++ b/src/webhooks/data/ghae/schema.json @@ -151319,24 +151319,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -151484,11 +151477,6 @@ "type": "string", "name": "secret_type", "description": "The type of secret that secret scanning detected.
" - }, - { - "type": "string", - "name": "secret", - "description": "The secret that was detected.
" } ] }, @@ -151589,24 +151577,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -151754,11 +151735,6 @@ "type": "string", "name": "secret_type", "description": "The type of secret that secret scanning detected.
" - }, - { - "type": "string", - "name": "secret", - "description": "The secret that was detected.
" } ] }, @@ -151829,11 +151805,26 @@ "description": "", "isRequired": true, "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
" + }, { "type": "string", "name": "created_at", "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" + }, { "type": "string", "name": "html_url", @@ -151844,163 +151835,18 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "integer", - "name": "number", - "description": "The security alert number.
" - }, - { - "type": "boolean or null", - "name": "push_protection_bypassed", - "description": "Whether push protection was bypassed for the detected secret.
" - }, - { - "type": "string or null", - "name": "push_protection_bypassed_at", - "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, { "type": "string or null", "name": "resolution", - "description": "Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ - null, "false_positive", "wont_fix", "revoked", "used_in_tests", "pattern_deleted", - "pattern_edited" + "pattern_edited", + null ] }, { @@ -152143,39 +151989,10 @@ "name": "resolution_comment", "description": "An optional comment to resolve an alert.
" }, - { - "type": "string", - "name": "secret", - "description": "The secret that was detected.
" - }, { "type": "string", "name": "secret_type", "description": "The type of secret that secret scanning detected.
" - }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" } ] }, @@ -152276,24 +152093,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -152441,11 +152251,6 @@ "type": "string", "name": "secret_type", "description": "The type of secret that secret scanning detected.
" - }, - { - "type": "string", - "name": "secret", - "description": "The secret that was detected.
" } ] }, @@ -152547,24 +152352,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -152712,11 +152510,6 @@ "type": "string", "name": "secret_type", "description": "The type of secret that secret scanning detected.
" - }, - { - "type": "string", - "name": "secret", - "description": "The secret that was detected.
" } ] }, diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index e87043d3d4..b811b282fd 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -165803,24 +165803,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -165969,16 +165962,6 @@ "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" - }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -166218,24 +166201,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -166384,16 +166360,6 @@ "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" - }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -166596,423 +166562,6 @@ ], "childParamsGroups": [] }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub URL of the alert resource.
" - }, - { - "type": "string", - "name": "locations_url", - "description": "The REST API URL of the code locations for this alert.
" - }, - { - "type": "integer", - "name": "number", - "description": "The security alert number.
" - }, - { - "type": "boolean or null", - "name": "push_protection_bypassed", - "description": "Whether push protection was bypassed for the detected secret.
" - }, - { - "type": "string or null", - "name": "push_protection_bypassed_at", - "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "resolution", - "description": "Required when the state is resolved. The reason for resolving the alert.
The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "resolution_comment", - "description": "An optional comment to resolve an alert.
" - }, - { - "type": "string", - "name": "secret", - "description": "The secret that was detected.
" - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that secret scanning detected.
" - }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "An enterprise on GitHub.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "A GitHub organization.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "A repository on GitHub.
", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "resolved", - "category": "secret_scanning_alert" - }, - "revoked": { - "descriptionHtml": "A secret scanning alert was marked as revoked.
", - "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "revoked" - ], - "childParamsGroups": [] - }, { "type": "object", "name": "alert", @@ -167050,24 +166599,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -167217,14 +166759,402 @@ "description": "The type of secret that secret scanning detected.
" }, { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
Whether push protection was bypassed for the detected secret.
" + }, + { + "type": "object", + "name": "push_protection_bypassed_by", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypassed_at", + "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "resolved", + "category": "secret_scanning_alert" + }, + "revoked": { + "descriptionHtml": "A secret scanning alert was marked as revoked.
", + "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "revoked" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
" }, { "type": "string", - "name": "secret", - "description": "The secret that was detected.
" + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" + }, + { + "type": "string", + "name": "html_url", + "description": "The GitHub URL of the alert resource.
" + }, + { + "type": "string", + "name": "locations_url", + "description": "The REST API URL of the code locations for this alert.
" + }, + { + "type": "string or null", + "name": "resolution", + "description": "The reason for resolving the alert.
", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + { + "type": "string or null", + "name": "resolved_at", + "description": "The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "resolution_comment", + "description": "An optional comment to resolve an alert.
" + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that secret scanning detected.
" }, { "type": "boolean or null", @@ -167466,24 +167396,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -167632,16 +167555,6 @@ "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" - }, { "type": "boolean or null", "name": "push_protection_bypassed", diff --git a/src/webhooks/data/ghes-3.7/schema.json b/src/webhooks/data/ghes-3.7/schema.json index aa6f3a2cc7..c60bb69c9d 100644 --- a/src/webhooks/data/ghes-3.7/schema.json +++ b/src/webhooks/data/ghes-3.7/schema.json @@ -145688,24 +145688,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -145849,16 +145842,6 @@ "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" - }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -146098,24 +146081,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -146259,16 +146235,6 @@ "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" - }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -146471,423 +146437,6 @@ ], "childParamsGroups": [] }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub URL of the alert resource.
" - }, - { - "type": "string", - "name": "locations_url", - "description": "The REST API URL of the code locations for this alert.
" - }, - { - "type": "integer", - "name": "number", - "description": "The security alert number.
" - }, - { - "type": "boolean or null", - "name": "push_protection_bypassed", - "description": "Whether push protection was bypassed for the detected secret.
" - }, - { - "type": "string or null", - "name": "push_protection_bypassed_at", - "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "resolution", - "description": "Required when the state is resolved. The reason for resolving the alert.
The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "resolution_comment", - "description": "An optional comment to resolve an alert.
" - }, - { - "type": "string", - "name": "secret", - "description": "The secret that was detected.
" - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that secret scanning detected.
" - }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "An enterprise on GitHub.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "A GitHub organization.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "A repository on GitHub.
", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "resolved", - "category": "secret_scanning_alert" - }, - "revoked": { - "descriptionHtml": "A secret scanning alert was marked as revoked.
", - "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "revoked" - ], - "childParamsGroups": [] - }, { "type": "object", "name": "alert", @@ -146925,24 +146474,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -147087,14 +146629,397 @@ "description": "The type of secret that secret scanning detected.
" }, { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
Whether push protection was bypassed for the detected secret.
" + }, + { + "type": "object", + "name": "push_protection_bypassed_by", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypassed_at", + "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "resolved", + "category": "secret_scanning_alert" + }, + "revoked": { + "descriptionHtml": "A secret scanning alert was marked as revoked.
", + "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "revoked" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
" }, { "type": "string", - "name": "secret", - "description": "The secret that was detected.
" + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" + }, + { + "type": "string", + "name": "html_url", + "description": "The GitHub URL of the alert resource.
" + }, + { + "type": "string", + "name": "locations_url", + "description": "The REST API URL of the code locations for this alert.
" + }, + { + "type": "string or null", + "name": "resolution", + "description": "The reason for resolving the alert.
", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + { + "type": "string or null", + "name": "resolved_at", + "description": "The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that secret scanning detected.
" }, { "type": "boolean or null", @@ -147336,24 +147261,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -147497,16 +147415,6 @@ "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" - }, { "type": "boolean or null", "name": "push_protection_bypassed", diff --git a/src/webhooks/data/ghes-3.8/schema.json b/src/webhooks/data/ghes-3.8/schema.json index 37eda507c6..5eba94e8bd 100644 --- a/src/webhooks/data/ghes-3.8/schema.json +++ b/src/webhooks/data/ghes-3.8/schema.json @@ -145688,24 +145688,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -145854,16 +145847,6 @@ "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" - }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -146103,24 +146086,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -146269,16 +146245,6 @@ "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" - }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -146481,423 +146447,6 @@ ], "childParamsGroups": [] }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub URL of the alert resource.
" - }, - { - "type": "string", - "name": "locations_url", - "description": "The REST API URL of the code locations for this alert.
" - }, - { - "type": "integer", - "name": "number", - "description": "The security alert number.
" - }, - { - "type": "boolean or null", - "name": "push_protection_bypassed", - "description": "Whether push protection was bypassed for the detected secret.
" - }, - { - "type": "string or null", - "name": "push_protection_bypassed_at", - "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "resolution", - "description": "Required when the state is resolved. The reason for resolving the alert.
The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "resolution_comment", - "description": "An optional comment to resolve an alert.
" - }, - { - "type": "string", - "name": "secret", - "description": "The secret that was detected.
" - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that secret scanning detected.
" - }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "An enterprise on GitHub.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "A GitHub organization.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "A repository on GitHub.
", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "resolved", - "category": "secret_scanning_alert" - }, - "revoked": { - "descriptionHtml": "A secret scanning alert was marked as revoked.
", - "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "revoked" - ], - "childParamsGroups": [] - }, { "type": "object", "name": "alert", @@ -146935,24 +146484,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -147102,14 +146644,402 @@ "description": "The type of secret that secret scanning detected.
" }, { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
Whether push protection was bypassed for the detected secret.
" + }, + { + "type": "object", + "name": "push_protection_bypassed_by", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypassed_at", + "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "resolved", + "category": "secret_scanning_alert" + }, + "revoked": { + "descriptionHtml": "A secret scanning alert was marked as revoked.
", + "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "revoked" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
" }, { "type": "string", - "name": "secret", - "description": "The secret that was detected.
" + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" + }, + { + "type": "string", + "name": "html_url", + "description": "The GitHub URL of the alert resource.
" + }, + { + "type": "string", + "name": "locations_url", + "description": "The REST API URL of the code locations for this alert.
" + }, + { + "type": "string or null", + "name": "resolution", + "description": "The reason for resolving the alert.
", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + { + "type": "string or null", + "name": "resolved_at", + "description": "The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "resolution_comment", + "description": "An optional comment to resolve an alert.
" + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that secret scanning detected.
" }, { "type": "boolean or null", @@ -147351,24 +147281,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -147517,16 +147440,6 @@ "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" - }, { "type": "boolean or null", "name": "push_protection_bypassed", diff --git a/src/webhooks/data/ghes-3.9/schema.json b/src/webhooks/data/ghes-3.9/schema.json index 0f4f47004e..10e1db00ce 100644 --- a/src/webhooks/data/ghes-3.9/schema.json +++ b/src/webhooks/data/ghes-3.9/schema.json @@ -149715,24 +149715,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -149881,16 +149874,6 @@ "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" - }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -150130,24 +150113,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -150296,16 +150272,6 @@ "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" - }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -150508,423 +150474,6 @@ ], "childParamsGroups": [] }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub URL of the alert resource.
" - }, - { - "type": "string", - "name": "locations_url", - "description": "The REST API URL of the code locations for this alert.
" - }, - { - "type": "integer", - "name": "number", - "description": "The security alert number.
" - }, - { - "type": "boolean or null", - "name": "push_protection_bypassed", - "description": "Whether push protection was bypassed for the detected secret.
" - }, - { - "type": "string or null", - "name": "push_protection_bypassed_at", - "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "resolution", - "description": "Required when the state is resolved. The reason for resolving the alert.
The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "resolution_comment", - "description": "An optional comment to resolve an alert.
" - }, - { - "type": "string", - "name": "secret", - "description": "The secret that was detected.
" - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that secret scanning detected.
" - }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "An enterprise on GitHub.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "A GitHub organization.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "A repository on GitHub.
", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "resolved", - "category": "secret_scanning_alert" - }, - "revoked": { - "descriptionHtml": "A secret scanning alert was marked as revoked.
", - "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "revoked" - ], - "childParamsGroups": [] - }, { "type": "object", "name": "alert", @@ -150962,24 +150511,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -151129,14 +150671,402 @@ "description": "The type of secret that secret scanning detected.
" }, { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
Whether push protection was bypassed for the detected secret.
" + }, + { + "type": "object", + "name": "push_protection_bypassed_by", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypassed_at", + "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "resolved", + "category": "secret_scanning_alert" + }, + "revoked": { + "descriptionHtml": "A secret scanning alert was marked as revoked.
", + "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "revoked" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
" }, { "type": "string", - "name": "secret", - "description": "The secret that was detected.
" + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" + }, + { + "type": "string", + "name": "html_url", + "description": "The GitHub URL of the alert resource.
" + }, + { + "type": "string", + "name": "locations_url", + "description": "The REST API URL of the code locations for this alert.
" + }, + { + "type": "string or null", + "name": "resolution", + "description": "The reason for resolving the alert.
", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + { + "type": "string or null", + "name": "resolved_at", + "description": "The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "resolution_comment", + "description": "An optional comment to resolve an alert.
" + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that secret scanning detected.
" }, { "type": "boolean or null", @@ -151378,24 +151308,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -151544,16 +151467,6 @@ "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" - }, { "type": "boolean or null", "name": "push_protection_bypassed", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 5fa257e694..f9bb69e570 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "8482a8d60da584a11eb150f7849ad78b2f58aadd" + "sha": "3be14a37ce061fe138c8a075e54e2bbeb7df2ac6" } \ No newline at end of file