From e91c1fed7ebacd9465a0d8533ddd0de4b908160f Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Wed, 12 Jun 2024 01:11:18 -0700 Subject: [PATCH] Update OpenAPI Description (#51125) --- src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 4 + src/rest/data/ghec-2022-11-28/schema.json | 4 + .../data/ghes-3.10-2022-11-28/schema.json | 4 + .../data/ghes-3.11-2022-11-28/schema.json | 4 + .../data/ghes-3.12-2022-11-28/schema.json | 4 + .../data/ghes-3.13-2022-11-28/schema.json | 4 + src/rest/data/ghes-3.9-2022-11-28/schema.json | 4 + src/rest/lib/config.json | 2 +- src/webhooks/data/fpt/schema.json | 25 + src/webhooks/data/ghec/schema.json | 1160 +++++++++++++++++ src/webhooks/lib/config.json | 2 +- 12 files changed, 1216 insertions(+), 3 deletions(-) diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index cea6c2b0b0..15ebb0ccce 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "0305b93e5aebf14aeb7548bd4d4d53adcf054386" + "sha": "0cbc71f6c0f48a2bc81be56158ea04b535402355" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index dd7c7a7383..9e87a140f8 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -474088,6 +474088,10 @@ "httpStatusCode": "302", "description": "

Found

" }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, { "httpStatusCode": "403", "description": "

Forbidden

" diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index cf082e9a8d..b60e07ebde 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -497630,6 +497630,10 @@ "httpStatusCode": "302", "description": "

Found

" }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, { "httpStatusCode": "403", "description": "

Forbidden

" diff --git a/src/rest/data/ghes-3.10-2022-11-28/schema.json b/src/rest/data/ghes-3.10-2022-11-28/schema.json index 2a2382eb13..2ff9f985c6 100644 --- a/src/rest/data/ghes-3.10-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.10-2022-11-28/schema.json @@ -436725,6 +436725,10 @@ "httpStatusCode": "302", "description": "

Found

" }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, { "httpStatusCode": "403", "description": "

Forbidden

" diff --git a/src/rest/data/ghes-3.11-2022-11-28/schema.json b/src/rest/data/ghes-3.11-2022-11-28/schema.json index 662ffb01fe..936a8dc93d 100644 --- a/src/rest/data/ghes-3.11-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.11-2022-11-28/schema.json @@ -442781,6 +442781,10 @@ "httpStatusCode": "302", "description": "

Found

" }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, { "httpStatusCode": "403", "description": "

Forbidden

" diff --git a/src/rest/data/ghes-3.12-2022-11-28/schema.json b/src/rest/data/ghes-3.12-2022-11-28/schema.json index 76dc27e97d..b520271f18 100644 --- a/src/rest/data/ghes-3.12-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.12-2022-11-28/schema.json @@ -445658,6 +445658,10 @@ "httpStatusCode": "302", "description": "

Found

" }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, { "httpStatusCode": "403", "description": "

Forbidden

" diff --git a/src/rest/data/ghes-3.13-2022-11-28/schema.json b/src/rest/data/ghes-3.13-2022-11-28/schema.json index 19c4c71813..cfe95a0c91 100644 --- a/src/rest/data/ghes-3.13-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.13-2022-11-28/schema.json @@ -450439,6 +450439,10 @@ "httpStatusCode": "302", "description": "

Found

" }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, { "httpStatusCode": "403", "description": "

Forbidden

" 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 d24fb85aa5..bd6779ec90 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 @@ -430204,6 +430204,10 @@ "httpStatusCode": "302", "description": "

Found

" }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, { "httpStatusCode": "403", "description": "

Forbidden

" diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 64b9eedf36..1795cf10ed 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -47,5 +47,5 @@ ] } }, - "sha": "0305b93e5aebf14aeb7548bd4d4d53adcf054386" + "sha": "0cbc71f6c0f48a2bc81be56158ea04b535402355" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 02976bf7b0..91d8f8eef9 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -208262,6 +208262,11 @@ "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.\"

" + }, { "type": "string", "name": "validity", @@ -208670,6 +208675,11 @@ "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.\"

" + }, { "type": "string", "name": "validity", @@ -209078,6 +209088,11 @@ "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.\"

" + }, { "type": "string", "name": "validity", @@ -209486,6 +209501,11 @@ "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.\"

" + }, { "type": "string", "name": "validity", @@ -209895,6 +209915,11 @@ "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.\"

" + }, { "type": "string", "name": "validity", diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 3568991dfa..f025c380aa 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -1041,6 +1041,1141 @@ "category": "branch_protection_rule" } }, + "bypass_request_secret_scanning": { + "cancelled": { + "descriptionHtml": "

A secret scanning push protection bypass request was cancelled.

", + "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "cancelled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "exemption_request", + "in": "body", + "description": "

A request from a user to be exempted from a set of rules.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The ID of the exemption request.

" + }, + { + "type": "integer", + "name": "number", + "description": "

The number uniquely identifying the exemption request within it's repository.

" + }, + { + "type": "integer", + "name": "repository_id", + "description": "

The ID of the repository the exemption request is for.

" + }, + { + "type": "integer", + "name": "requester_id", + "description": "

The ID of the user who requested the exemption.

" + }, + { + "type": "string", + "name": "requester_login", + "description": "

The login of the user who requested the exemption.

" + }, + { + "type": "string", + "name": "request_type", + "description": "

The type of request.

", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + { + "type": "object", + "name": "exemption_request_data", + "description": "

Push rules that are being requested to be bypassed.

" + }, + { + "type": "string", + "name": "resource_identifier", + "description": "

The unique identifier for the request type of the exemption request. For example, a commit SHA.

" + }, + { + "type": "string", + "name": "status", + "description": "

The status of the exemption request.

", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + { + "type": "string or null", + "name": "requester_comment", + "description": "

The comment the requester provided when creating the exemption request.

" + }, + { + "type": "object or null", + "name": "metadata", + "description": "

Metadata about the exemption request.

", + "childParamsGroups": [ + { + "type": "object", + "name": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "

Metadata for a secret scanning push protection exemption request.

", + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "

The label for the secret type

" + }, + { + "type": "string", + "name": "reason", + "description": "

The reason for the exemption request

", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + ] + } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "expires_at", + "description": "

The date and time the exemption request will expire.

" + }, + { + "type": "string", + "name": "created_at", + "description": "

The date and time the exemption request was created.

" + }, + { + "type": "array of objects or null", + "name": "responses", + "description": "

The responses to the exemption request.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The ID of the exemption response.

" + }, + { + "type": "integer", + "name": "reviewer_id", + "description": "

The ID of the user who reviewed the exemption request.

" + }, + { + "type": "string", + "name": "reviewer_login", + "description": "

The login of the user who reviewed the exemption request.

" + }, + { + "type": "string", + "name": "status", + "description": "

The status of the exemption response.

", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + { + "type": "string", + "name": "created_at", + "description": "

The date and time the exemption request was created.

" + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "

The URL to view the exemption request in a browser.

" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

The GitHub user that triggered the event. This property is included in every webhook payload.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "cancelled", + "category": "bypass_request_secret_scanning" + }, + "completed": { + "descriptionHtml": "

A secret scanning bypass request was completed.

", + "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "completed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "exemption_request", + "in": "body", + "description": "

A request from a user to be exempted from a set of rules.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The ID of the exemption request.

" + }, + { + "type": "integer", + "name": "number", + "description": "

The number uniquely identifying the exemption request within it's repository.

" + }, + { + "type": "integer", + "name": "repository_id", + "description": "

The ID of the repository the exemption request is for.

" + }, + { + "type": "integer", + "name": "requester_id", + "description": "

The ID of the user who requested the exemption.

" + }, + { + "type": "string", + "name": "requester_login", + "description": "

The login of the user who requested the exemption.

" + }, + { + "type": "string", + "name": "request_type", + "description": "

The type of request.

", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + { + "type": "object", + "name": "exemption_request_data", + "description": "

Push rules that are being requested to be bypassed.

" + }, + { + "type": "string", + "name": "resource_identifier", + "description": "

The unique identifier for the request type of the exemption request. For example, a commit SHA.

" + }, + { + "type": "string", + "name": "status", + "description": "

The status of the exemption request.

", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + { + "type": "string or null", + "name": "requester_comment", + "description": "

The comment the requester provided when creating the exemption request.

" + }, + { + "type": "object or null", + "name": "metadata", + "description": "

Metadata about the exemption request.

", + "childParamsGroups": [ + { + "type": "object", + "name": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "

Metadata for a secret scanning push protection exemption request.

", + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "

The label for the secret type

" + }, + { + "type": "string", + "name": "reason", + "description": "

The reason for the exemption request

", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + ] + } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "expires_at", + "description": "

The date and time the exemption request will expire.

" + }, + { + "type": "string", + "name": "created_at", + "description": "

The date and time the exemption request was created.

" + }, + { + "type": "array of objects or null", + "name": "responses", + "description": "

The responses to the exemption request.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The ID of the exemption response.

" + }, + { + "type": "integer", + "name": "reviewer_id", + "description": "

The ID of the user who reviewed the exemption request.

" + }, + { + "type": "string", + "name": "reviewer_login", + "description": "

The login of the user who reviewed the exemption request.

" + }, + { + "type": "string", + "name": "status", + "description": "

The status of the exemption response.

", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + { + "type": "string", + "name": "created_at", + "description": "

The date and time the exemption request was created.

" + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "

The URL to view the exemption request in a browser.

" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

The GitHub user that triggered the event. This property is included in every webhook payload.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "completed", + "category": "bypass_request_secret_scanning" + }, + "created": { + "descriptionHtml": "

A secret scanning push protection bypass request was created.

", + "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "exemption_request", + "in": "body", + "description": "

A request from a user to be exempted from a set of rules.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The ID of the exemption request.

" + }, + { + "type": "integer", + "name": "number", + "description": "

The number uniquely identifying the exemption request within it's repository.

" + }, + { + "type": "integer", + "name": "repository_id", + "description": "

The ID of the repository the exemption request is for.

" + }, + { + "type": "integer", + "name": "requester_id", + "description": "

The ID of the user who requested the exemption.

" + }, + { + "type": "string", + "name": "requester_login", + "description": "

The login of the user who requested the exemption.

" + }, + { + "type": "string", + "name": "request_type", + "description": "

The type of request.

", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + { + "type": "object", + "name": "exemption_request_data", + "description": "

Push rules that are being requested to be bypassed.

" + }, + { + "type": "string", + "name": "resource_identifier", + "description": "

The unique identifier for the request type of the exemption request. For example, a commit SHA.

" + }, + { + "type": "string", + "name": "status", + "description": "

The status of the exemption request.

", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + { + "type": "string or null", + "name": "requester_comment", + "description": "

The comment the requester provided when creating the exemption request.

" + }, + { + "type": "object or null", + "name": "metadata", + "description": "

Metadata about the exemption request.

", + "childParamsGroups": [ + { + "type": "object", + "name": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "

Metadata for a secret scanning push protection exemption request.

", + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "

The label for the secret type

" + }, + { + "type": "string", + "name": "reason", + "description": "

The reason for the exemption request

", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + ] + } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "expires_at", + "description": "

The date and time the exemption request will expire.

" + }, + { + "type": "string", + "name": "created_at", + "description": "

The date and time the exemption request was created.

" + }, + { + "type": "array of objects or null", + "name": "responses", + "description": "

The responses to the exemption request.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The ID of the exemption response.

" + }, + { + "type": "integer", + "name": "reviewer_id", + "description": "

The ID of the user who reviewed the exemption request.

" + }, + { + "type": "string", + "name": "reviewer_login", + "description": "

The login of the user who reviewed the exemption request.

" + }, + { + "type": "string", + "name": "status", + "description": "

The status of the exemption response.

", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + { + "type": "string", + "name": "created_at", + "description": "

The date and time the exemption request was created.

" + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "

The URL to view the exemption request in a browser.

" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

The GitHub user that triggered the event. This property is included in every webhook payload.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "bypass_request_secret_scanning" + }, + "response_dismissed": { + "descriptionHtml": "

A secret scanning push protection bypass response was dismissed.

", + "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "response_dismissed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "exemption_request", + "in": "body", + "description": "

A request from a user to be exempted from a set of rules.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The ID of the exemption request.

" + }, + { + "type": "integer", + "name": "number", + "description": "

The number uniquely identifying the exemption request within it's repository.

" + }, + { + "type": "integer", + "name": "repository_id", + "description": "

The ID of the repository the exemption request is for.

" + }, + { + "type": "integer", + "name": "requester_id", + "description": "

The ID of the user who requested the exemption.

" + }, + { + "type": "string", + "name": "requester_login", + "description": "

The login of the user who requested the exemption.

" + }, + { + "type": "string", + "name": "request_type", + "description": "

The type of request.

", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + { + "type": "object", + "name": "exemption_request_data", + "description": "

Push rules that are being requested to be bypassed.

" + }, + { + "type": "string", + "name": "resource_identifier", + "description": "

The unique identifier for the request type of the exemption request. For example, a commit SHA.

" + }, + { + "type": "string", + "name": "status", + "description": "

The status of the exemption request.

", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + { + "type": "string or null", + "name": "requester_comment", + "description": "

The comment the requester provided when creating the exemption request.

" + }, + { + "type": "object or null", + "name": "metadata", + "description": "

Metadata about the exemption request.

", + "childParamsGroups": [ + { + "type": "object", + "name": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "

Metadata for a secret scanning push protection exemption request.

", + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "

The label for the secret type

" + }, + { + "type": "string", + "name": "reason", + "description": "

The reason for the exemption request

", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + ] + } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "expires_at", + "description": "

The date and time the exemption request will expire.

" + }, + { + "type": "string", + "name": "created_at", + "description": "

The date and time the exemption request was created.

" + }, + { + "type": "array of objects or null", + "name": "responses", + "description": "

The responses to the exemption request.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The ID of the exemption response.

" + }, + { + "type": "integer", + "name": "reviewer_id", + "description": "

The ID of the user who reviewed the exemption request.

" + }, + { + "type": "string", + "name": "reviewer_login", + "description": "

The login of the user who reviewed the exemption request.

" + }, + { + "type": "string", + "name": "status", + "description": "

The status of the exemption response.

", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + { + "type": "string", + "name": "created_at", + "description": "

The date and time the exemption request was created.

" + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "

The URL to view the exemption request in a browser.

" + } + ] + }, + { + "type": "object", + "name": "exemption_response", + "in": "body", + "description": "

A response to an exemption request by a delegated bypasser.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The ID of the exemption response.

" + }, + { + "type": "integer", + "name": "reviewer_id", + "description": "

The ID of the user who reviewed the exemption request.

" + }, + { + "type": "string", + "name": "reviewer_login", + "description": "

The login of the user who reviewed the exemption request.

" + }, + { + "type": "string", + "name": "status", + "description": "

The status of the exemption response.

", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + { + "type": "string", + "name": "created_at", + "description": "

The date and time the exemption request was created.

" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

The GitHub user that triggered the event. This property is included in every webhook payload.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "response_dismissed", + "category": "bypass_request_secret_scanning" + }, + "response_submitted": { + "descriptionHtml": "

A response either approving or rejecting the secret scanning push protection bypass request was submitted.

", + "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "response_submitted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "exemption_request", + "in": "body", + "description": "

A request from a user to be exempted from a set of rules.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The ID of the exemption request.

" + }, + { + "type": "integer", + "name": "number", + "description": "

The number uniquely identifying the exemption request within it's repository.

" + }, + { + "type": "integer", + "name": "repository_id", + "description": "

The ID of the repository the exemption request is for.

" + }, + { + "type": "integer", + "name": "requester_id", + "description": "

The ID of the user who requested the exemption.

" + }, + { + "type": "string", + "name": "requester_login", + "description": "

The login of the user who requested the exemption.

" + }, + { + "type": "string", + "name": "request_type", + "description": "

The type of request.

", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + { + "type": "object", + "name": "exemption_request_data", + "description": "

Push rules that are being requested to be bypassed.

" + }, + { + "type": "string", + "name": "resource_identifier", + "description": "

The unique identifier for the request type of the exemption request. For example, a commit SHA.

" + }, + { + "type": "string", + "name": "status", + "description": "

The status of the exemption request.

", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + { + "type": "string or null", + "name": "requester_comment", + "description": "

The comment the requester provided when creating the exemption request.

" + }, + { + "type": "object or null", + "name": "metadata", + "description": "

Metadata about the exemption request.

", + "childParamsGroups": [ + { + "type": "object", + "name": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "

Metadata for a secret scanning push protection exemption request.

", + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "

The label for the secret type

" + }, + { + "type": "string", + "name": "reason", + "description": "

The reason for the exemption request

", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + ] + } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "expires_at", + "description": "

The date and time the exemption request will expire.

" + }, + { + "type": "string", + "name": "created_at", + "description": "

The date and time the exemption request was created.

" + }, + { + "type": "array of objects or null", + "name": "responses", + "description": "

The responses to the exemption request.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The ID of the exemption response.

" + }, + { + "type": "integer", + "name": "reviewer_id", + "description": "

The ID of the user who reviewed the exemption request.

" + }, + { + "type": "string", + "name": "reviewer_login", + "description": "

The login of the user who reviewed the exemption request.

" + }, + { + "type": "string", + "name": "status", + "description": "

The status of the exemption response.

", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + { + "type": "string", + "name": "created_at", + "description": "

The date and time the exemption request was created.

" + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "

The URL to view the exemption request in a browser.

" + } + ] + }, + { + "type": "object", + "name": "exemption_response", + "in": "body", + "description": "

A response to an exemption request by a delegated bypasser.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The ID of the exemption response.

" + }, + { + "type": "integer", + "name": "reviewer_id", + "description": "

The ID of the user who reviewed the exemption request.

" + }, + { + "type": "string", + "name": "reviewer_login", + "description": "

The login of the user who reviewed the exemption request.

" + }, + { + "type": "string", + "name": "status", + "description": "

The status of the exemption response.

", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + { + "type": "string", + "name": "created_at", + "description": "

The date and time the exemption request was created.

" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

The GitHub user that triggered the event. This property is included in every webhook payload.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "response_submitted", + "category": "bypass_request_secret_scanning" + } + }, "check_run": { "completed": { "descriptionHtml": "

A check run was completed, and a conclusion is available.

", @@ -208326,6 +209461,11 @@ "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.\"

" + }, { "type": "string", "name": "validity", @@ -208734,6 +209874,11 @@ "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.\"

" + }, { "type": "string", "name": "validity", @@ -209142,6 +210287,11 @@ "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.\"

" + }, { "type": "string", "name": "validity", @@ -209550,6 +210700,11 @@ "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.\"

" + }, { "type": "string", "name": "validity", @@ -209959,6 +211114,11 @@ "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.\"

" + }, { "type": "string", "name": "validity", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 6cf8cb87eb..1f7a55171e 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "0305b93e5aebf14aeb7548bd4d4d53adcf054386" + "sha": "0cbc71f6c0f48a2bc81be56158ea04b535402355" } \ No newline at end of file