From 73d0e537615b704431979da06c550975e518f26f Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Fri, 18 Apr 2025 11:55:07 -0700 Subject: [PATCH 1/2] Update OpenAPI Description (#55341) Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com> --- .../alert-dismissal-requests.md | 13 + content/rest/secret-scanning/index.md | 1 + .../fine-grained-pat-permissions.json | 63 + .../ghec-2022-11-28/fine-grained-pat.json | 24 + .../server-to-server-permissions.json | 77 + .../server-to-server-rest.json | 24 + .../ghec-2022-11-28/user-to-server-rest.json | 24 + src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 21 +- src/rest/data/ghec-2022-11-28/schema.json | 1314 ++++++++++++++++- .../data/ghes-3.12-2022-11-28/schema.json | 3 +- .../data/ghes-3.13-2022-11-28/schema.json | 3 +- .../data/ghes-3.14-2022-11-28/schema.json | 3 +- .../data/ghes-3.15-2022-11-28/schema.json | 9 +- .../data/ghes-3.16-2022-11-28/schema.json | 21 +- src/rest/lib/config.json | 2 +- src/webhooks/lib/config.json | 2 +- 17 files changed, 1551 insertions(+), 55 deletions(-) create mode 100644 content/rest/secret-scanning/alert-dismissal-requests.md diff --git a/content/rest/secret-scanning/alert-dismissal-requests.md b/content/rest/secret-scanning/alert-dismissal-requests.md new file mode 100644 index 000000000000..463759556997 --- /dev/null +++ b/content/rest/secret-scanning/alert-dismissal-requests.md @@ -0,0 +1,13 @@ +--- +title: Alert dismissal requests +shortTitle: Alert dismissal requests +intro: Use the REST API to manage alert dismissal requests for secret scanning. +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + ghec: '*' +topics: + - API +autogenerated: rest +allowTitleToDifferFromFilename: true +--- + + diff --git a/content/rest/secret-scanning/index.md b/content/rest/secret-scanning/index.md index d7beeb4edb63..f11c3b31caf0 100644 --- a/content/rest/secret-scanning/index.md +++ b/content/rest/secret-scanning/index.md @@ -10,6 +10,7 @@ versions: topics: - API children: + - /alert-dismissal-requests - /delegated-bypass - /secret-scanning autogenerated: rest diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json index a97afbce352d..589a0550cb36 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json @@ -5460,6 +5460,33 @@ "additional-permissions": false, "access": "write" }, + { + "category": "secret-scanning", + "slug": "list-alert-dismissal-requests-for-secret-scanning-for-a-repository", + "subcategory": "alert-dismissal-requests", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning", + "additional-permissions": true, + "access": "read" + }, + { + "category": "secret-scanning", + "slug": "get-an-alert-dismissal-request-for-secret-scanning", + "subcategory": "alert-dismissal-requests", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "secret-scanning", + "slug": "review-an-alert-dismissal-request-for-secret-scanning", + "subcategory": "alert-dismissal-requests", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}", + "additional-permissions": true, + "access": "read" + }, { "category": "repos", "slug": "create-a-repository-dispatch-event", @@ -8007,6 +8034,15 @@ "additional-permissions": false, "access": "read" }, + { + "category": "secret-scanning", + "slug": "list-alert-dismissal-requests-for-secret-scanning-for-an-org", + "subcategory": "alert-dismissal-requests", + "verb": "get", + "requestPath": "/orgs/{org}/dismissal-requests/secret-scanning", + "additional-permissions": false, + "access": "read" + }, { "category": "secret-scanning", "slug": "list-secret-scanning-alerts-for-an-organization", @@ -8052,6 +8088,33 @@ "additional-permissions": false, "access": "read" }, + { + "category": "secret-scanning", + "slug": "list-alert-dismissal-requests-for-secret-scanning-for-a-repository", + "subcategory": "alert-dismissal-requests", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning", + "additional-permissions": true, + "access": "read" + }, + { + "category": "secret-scanning", + "slug": "get-an-alert-dismissal-request-for-secret-scanning", + "subcategory": "alert-dismissal-requests", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "secret-scanning", + "slug": "review-an-alert-dismissal-request-for-secret-scanning", + "subcategory": "alert-dismissal-requests", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}", + "additional-permissions": true, + "access": "read" + }, { "category": "secret-scanning", "slug": "list-secret-scanning-alerts-for-a-repository", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json index acfc152255d5..fd6e89ba4d36 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json @@ -5356,6 +5356,12 @@ "verb": "get", "requestPath": "/orgs/{org}/bypass-requests/secret-scanning" }, + { + "slug": "list-alert-dismissal-requests-for-secret-scanning-for-an-org", + "subcategory": "alert-dismissal-requests", + "verb": "get", + "requestPath": "/orgs/{org}/dismissal-requests/secret-scanning" + }, { "slug": "list-secret-scanning-alerts-for-an-organization", "subcategory": "secret-scanning", @@ -5386,6 +5392,24 @@ "verb": "delete", "requestPath": "/repos/{owner}/{repo}/bypass-responses/secret-scanning/{bypass_response_id}" }, + { + "slug": "list-alert-dismissal-requests-for-secret-scanning-for-a-repository", + "subcategory": "alert-dismissal-requests", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning" + }, + { + "slug": "get-an-alert-dismissal-request-for-secret-scanning", + "subcategory": "alert-dismissal-requests", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}" + }, + { + "slug": "review-an-alert-dismissal-request-for-secret-scanning", + "subcategory": "alert-dismissal-requests", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}" + }, { "slug": "list-secret-scanning-alerts-for-a-repository", "subcategory": "secret-scanning", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json index 12274acb2bb2..c4cb1a843054 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json @@ -6622,6 +6622,39 @@ "server-to-server": true, "additional-permissions": false }, + { + "category": "secret-scanning", + "slug": "list-alert-dismissal-requests-for-secret-scanning-for-a-repository", + "subcategory": "alert-dismissal-requests", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "secret-scanning", + "slug": "get-an-alert-dismissal-request-for-secret-scanning", + "subcategory": "alert-dismissal-requests", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "secret-scanning", + "slug": "review-an-alert-dismissal-request-for-secret-scanning", + "subcategory": "alert-dismissal-requests", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, { "category": "repos", "slug": "create-a-repository-dispatch-event", @@ -9730,6 +9763,17 @@ "server-to-server": false, "additional-permissions": false }, + { + "category": "secret-scanning", + "slug": "list-alert-dismissal-requests-for-secret-scanning-for-an-org", + "subcategory": "alert-dismissal-requests", + "verb": "get", + "requestPath": "/orgs/{org}/dismissal-requests/secret-scanning", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "secret-scanning", "slug": "list-secret-scanning-alerts-for-an-organization", @@ -9785,6 +9829,39 @@ "server-to-server": false, "additional-permissions": false }, + { + "category": "secret-scanning", + "slug": "list-alert-dismissal-requests-for-secret-scanning-for-a-repository", + "subcategory": "alert-dismissal-requests", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "secret-scanning", + "slug": "get-an-alert-dismissal-request-for-secret-scanning", + "subcategory": "alert-dismissal-requests", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "secret-scanning", + "slug": "review-an-alert-dismissal-request-for-secret-scanning", + "subcategory": "alert-dismissal-requests", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, { "category": "secret-scanning", "slug": "list-secret-scanning-alerts-for-a-repository", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index 88905dd9e865..bf50fed338a0 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -4870,12 +4870,36 @@ } ], "secret-scanning": [ + { + "slug": "list-alert-dismissal-requests-for-secret-scanning-for-an-org", + "subcategory": "alert-dismissal-requests", + "verb": "get", + "requestPath": "/orgs/{org}/dismissal-requests/secret-scanning" + }, { "slug": "list-secret-scanning-alerts-for-an-organization", "subcategory": "secret-scanning", "verb": "get", "requestPath": "/orgs/{org}/secret-scanning/alerts" }, + { + "slug": "list-alert-dismissal-requests-for-secret-scanning-for-a-repository", + "subcategory": "alert-dismissal-requests", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning" + }, + { + "slug": "get-an-alert-dismissal-request-for-secret-scanning", + "subcategory": "alert-dismissal-requests", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}" + }, + { + "slug": "review-an-alert-dismissal-request-for-secret-scanning", + "subcategory": "alert-dismissal-requests", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}" + }, { "slug": "list-secret-scanning-alerts-for-a-repository", "subcategory": "secret-scanning", diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json index acfc152255d5..fd6e89ba4d36 100644 --- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json @@ -5356,6 +5356,12 @@ "verb": "get", "requestPath": "/orgs/{org}/bypass-requests/secret-scanning" }, + { + "slug": "list-alert-dismissal-requests-for-secret-scanning-for-an-org", + "subcategory": "alert-dismissal-requests", + "verb": "get", + "requestPath": "/orgs/{org}/dismissal-requests/secret-scanning" + }, { "slug": "list-secret-scanning-alerts-for-an-organization", "subcategory": "secret-scanning", @@ -5386,6 +5392,24 @@ "verb": "delete", "requestPath": "/repos/{owner}/{repo}/bypass-responses/secret-scanning/{bypass_response_id}" }, + { + "slug": "list-alert-dismissal-requests-for-secret-scanning-for-a-repository", + "subcategory": "alert-dismissal-requests", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning" + }, + { + "slug": "get-an-alert-dismissal-request-for-secret-scanning", + "subcategory": "alert-dismissal-requests", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}" + }, + { + "slug": "review-an-alert-dismissal-request-for-secret-scanning", + "subcategory": "alert-dismissal-requests", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}" + }, { "slug": "list-secret-scanning-alerts-for-a-repository", "subcategory": "secret-scanning", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 1820b2a95cfd..7a79ca227d95 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "c5cf21bd038d40077bcb9a9dffd0c8d0691c1d78" + "sha": "a3b90207333d17877bcbab612a4163337ed7148c" } \ 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 a0c0e7525320..52b516e486ea 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -144111,7 +144111,7 @@ } ], "previews": [], - "descriptionHTML": "
Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run
webhook event with the action rerequested
. When a check run is rerequested
, its status
is reset to queued
and the conclusion
is cleared.
For more information about how to re-run GitHub Actions jobs, see \"Re-run a job from a workflow run\".
\nOAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run
webhook event with the action rerequested
. When a check run is rerequested
, the status
of the check suite it belongs to is reset to queued
and the conclusion
is cleared. The check run itself is not updated. GitHub apps recieving the check_run
webhook with the rerequested
action should then decide if the check run should be reset or updated and call the update check_run
endpoint to update the check_run if desired.
For more information about how to re-run GitHub Actions jobs, see \"Re-run a job from a workflow run\".
\nOAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "201", @@ -264215,6 +264215,7 @@ "cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8", "cool": "https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8", "cop": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", + "copilot": "https://github.githubassets.com/images/icons/emoji/copilot.png?v8", "copyright": "https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8", "corn": "https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8", "costa_rica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8", @@ -435804,7 +435805,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nLists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Lists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.
\nOAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.
\nOAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Get the configuration of a single private registry defined for an organization, omitting its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nDelete a private registry configuration at the organization-level.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Delete a private registry configuration at the organization-level.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", "required": false, "schema": { "type": "string" @@ -562729,7 +562730,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", "required": false, "schema": { "type": "string" @@ -564409,7 +564410,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", "required": false, "schema": { "type": "string" diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index c0aca7720a1a..1f083d578c2a 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -153527,7 +153527,7 @@ } ], "previews": [], - "descriptionHTML": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run
webhook event with the action rerequested
. When a check run is rerequested
, its status
is reset to queued
and the conclusion
is cleared.
For more information about how to re-run GitHub Actions jobs, see \"Re-run a job from a workflow run\".
\nOAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run
webhook event with the action rerequested
. When a check run is rerequested
, the status
of the check suite it belongs to is reset to queued
and the conclusion
is cleared. The check run itself is not updated. GitHub apps recieving the check_run
webhook with the rerequested
action should then decide if the check run should be reset or updated and call the update check_run
endpoint to update the check_run if desired.
For more information about how to re-run GitHub Actions jobs, see \"Re-run a job from a workflow run\".
\nOAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "201", @@ -277547,6 +277547,7 @@ "cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8", "cool": "https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8", "cop": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", + "copilot": "https://github.githubassets.com/images/icons/emoji/copilot.png?v8", "copyright": "https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8", "corn": "https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8", "costa_rica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8", @@ -281665,18 +281666,6 @@ "name": "users", "in": "body", "description": "The usernames of the users to add to the cost center.
" - }, - { - "type": "array of strings", - "name": "organizations", - "in": "body", - "description": "The organizations to add to the cost center.
" - }, - { - "type": "array of strings", - "name": "repositories", - "in": "body", - "description": "The repositories to add to the cost center.
" } ], "progAccess": { @@ -281721,7 +281710,7 @@ } ], "previews": [], - "descriptionHTML": "Adds users, orgs, or repos to a cost center.
\nThe usage for the users will be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint.
", + "descriptionHTML": "Adds users to a cost center.
\nThe usage for the users will be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -281781,8 +281770,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "The usernames of the users to remove from the cost center.
", - "isRequired": true + "description": "The usernames of the users to remove from the cost center.
" } ], "progAccess": { @@ -473304,7 +473292,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nLists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Lists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.
\nOAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.
\nOAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Get the configuration of a single private registry defined for an organization, omitting its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nDelete a private registry configuration at the organization-level.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Delete a private registry configuration at the organization-level.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", "required": false, "schema": { "type": "string" @@ -603875,7 +603863,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", "required": false, "schema": { "type": "string" @@ -605555,7 +605543,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", "required": false, "schema": { "type": "string" @@ -609141,6 +609129,1282 @@ ] } ], + "alert-dismissal-requests": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/dismissal-requests/secret-scanning", + "title": "List alert dismissal requests for secret scanning for an org", + "category": "secret-scanning", + "subcategory": "alert-dismissal-requests", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_name", + "description": "The name of the repository to filter on.
", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "reviewer", + "description": "Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "requester", + "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "The time period to filter by.
\nFor example, day
will filter for rule suites that occurred in the past 24 hours, and week
will filter for insights that occurred in the past 7 days (168 hours).
The status of the dismissal request to filter on. When specified, only requests with this status will be returned.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "cancelled", + "approved", + "expired", + "denied", + "open", + "all" + ], + "default": "all" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secret scanning alerts\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "A list of the alert dismissal requests.
", + "example": [ + { + "id": 21, + "number": 42, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning_closure", + "data": [ + { + "secret_type": "adafruit_io_key", + "alert_number": 17 + } + ], + "resource_identifier": 17, + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/21", + "html_url": "https://github.com/octo-org/smile/security/secret-scanning/17" + }, + { + "id": 22, + "number": 43, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning_closure", + "data": [ + { + "secret_type": "adafruit_io_key", + "alert_number": 19 + } + ], + "resource_identifier": 19, + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 46, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "approved", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/22", + "html_url": "https://github.com/octo-org/smile/security/secret-scanning/19" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Secret scanning alert dismissal request", + "description": "A dismissal request made by a user asking to close a secret scanning alert in this repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the dismissal request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the dismissal request within its repository." + }, + "repository": { + "type": "object", + "description": "The repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the repository the dismissal request is for." + }, + "name": { + "type": "string", + "description": "The name of the repository the dismissal request is for." + }, + "full_name": { + "type": "string", + "description": "The full name of the repository the dismissal request is for." + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the organization." + }, + "name": { + "type": "string", + "description": "The name of the organization." + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the dismissal.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who requested the dismissal." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who requested the dismissal." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "type": [ + "array", + "null" + ], + "description": "Data describing the secret alert that is being requested to be dismissed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "alert_number": { + "type": "string", + "description": "The number of the secret scanning alert that was detected." + } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The number of the secret scanning alert that was detected.", + "examples": [ + 1234 + ] + }, + "status": { + "type": "string", + "description": "The status of the dismissal request.", + "enum": [ + "pending", + "denied", + "approved", + "cancelled", + "expired" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the dismissal request." + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the dismissal request.", + "items": { + "title": "Bypass response", + "description": "A response made by a delegated bypasser to a bypass request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the response to the bypass request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the bypass request.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who reviewed the bypass request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the bypass request." + } + } + }, + "status": { + "type": "string", + "description": "The response status to the bypass request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the bypass request was created." + } + } + } + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/1" + ] + }, + "html_url": { + "type": "string", + "description": "The URL to view the dismissal request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/octo-org/smile/security/secret-scanning/17" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists requests to dismiss secret scanning alerts in an org.
\nDelegated alert dismissal must be enabled on repositories in the org and the user must be an org admin, security manager,\nor have the \"Review and manage secret scanning alert dismissal requests\" permission to access this endpoint.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "A list of the alert dismissal requests.
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning", + "title": "List alert dismissal requests for secret scanning for a repository", + "category": "secret-scanning", + "subcategory": "alert-dismissal-requests", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git
extension. The name is not case sensitive.
Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "requester", + "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "The time period to filter by.
\nFor example, day
will filter for rule suites that occurred in the past 24 hours, and week
will filter for insights that occurred in the past 7 days (168 hours).
The status of the dismissal request to filter on. When specified, only requests with this status will be returned.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "cancelled", + "approved", + "expired", + "denied", + "open", + "all" + ], + "default": "all" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secret scanning alerts\" repository permissions": "read", + "\"Contents\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "A list of the alert dismissal requests.
", + "example": [ + { + "id": 21, + "number": 42, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning_closure", + "data": [ + { + "secret_type": "adafruit_io_key", + "alert_number": 17 + } + ], + "resource_identifier": 17, + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/21", + "html_url": "https://github.com/octo-org/smile/security/secret-scanning/17" + }, + { + "id": 22, + "number": 43, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning_closure", + "data": [ + { + "secret_type": "adafruit_io_key", + "alert_number": 19 + } + ], + "resource_identifier": 19, + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 46, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "approved", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/22", + "html_url": "https://github.com/octo-org/smile/security/secret-scanning/19" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Secret scanning alert dismissal request", + "description": "A dismissal request made by a user asking to close a secret scanning alert in this repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the dismissal request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the dismissal request within its repository." + }, + "repository": { + "type": "object", + "description": "The repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the repository the dismissal request is for." + }, + "name": { + "type": "string", + "description": "The name of the repository the dismissal request is for." + }, + "full_name": { + "type": "string", + "description": "The full name of the repository the dismissal request is for." + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the organization." + }, + "name": { + "type": "string", + "description": "The name of the organization." + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the dismissal.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who requested the dismissal." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who requested the dismissal." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "type": [ + "array", + "null" + ], + "description": "Data describing the secret alert that is being requested to be dismissed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "alert_number": { + "type": "string", + "description": "The number of the secret scanning alert that was detected." + } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The number of the secret scanning alert that was detected.", + "examples": [ + 1234 + ] + }, + "status": { + "type": "string", + "description": "The status of the dismissal request.", + "enum": [ + "pending", + "denied", + "approved", + "cancelled", + "expired" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the dismissal request." + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the dismissal request.", + "items": { + "title": "Bypass response", + "description": "A response made by a delegated bypasser to a bypass request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the response to the bypass request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the bypass request.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who reviewed the bypass request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the bypass request." + } + } + }, + "status": { + "type": "string", + "description": "The response status to the bypass request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the bypass request was created." + } + } + } + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/1" + ] + }, + "html_url": { + "type": "string", + "description": "The URL to view the dismissal request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/octo-org/smile/security/secret-scanning/17" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists requests to dismiss secret scanning alerts in a repository.
\nDelegated alert dismissal must be enabled on the repository and the user must be an org admin, security manager,\nor have the \"Review and manage secret scanning alert dismissal requests\" permission to access this endpoint.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "A list of the alert dismissal requests.
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}", + "title": "Get an alert dismissal request for secret scanning", + "category": "secret-scanning", + "subcategory": "alert-dismissal-requests", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git
extension. The name is not case sensitive.
The number that identifies the secret scanning alert in a repository.
", + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secret scanning alerts\" repository permissions": "read", + "\"Contents\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "alert_number": "ALERT_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "A single dismissal request.
", + "example": { + "id": 21, + "number": 42, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning_closure", + "data": [ + { + "secret_type": "adafruit_io_key", + "alert_number": 17 + } + ], + "resource_identifier": 17, + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/21", + "html_url": "https://github.com/octo-org/smile/security/secret-scanning/17" + }, + "schema": { + "title": "Secret scanning alert dismissal request", + "description": "A dismissal request made by a user asking to close a secret scanning alert in this repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the dismissal request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the dismissal request within its repository." + }, + "repository": { + "type": "object", + "description": "The repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the repository the dismissal request is for." + }, + "name": { + "type": "string", + "description": "The name of the repository the dismissal request is for." + }, + "full_name": { + "type": "string", + "description": "The full name of the repository the dismissal request is for." + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the organization." + }, + "name": { + "type": "string", + "description": "The name of the organization." + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the dismissal.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who requested the dismissal." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who requested the dismissal." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "type": [ + "array", + "null" + ], + "description": "Data describing the secret alert that is being requested to be dismissed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "alert_number": { + "type": "string", + "description": "The number of the secret scanning alert that was detected." + } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The number of the secret scanning alert that was detected.", + "examples": [ + 1234 + ] + }, + "status": { + "type": "string", + "description": "The status of the dismissal request.", + "enum": [ + "pending", + "denied", + "approved", + "cancelled", + "expired" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the dismissal request." + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the dismissal request.", + "items": { + "title": "Bypass response", + "description": "A response made by a delegated bypasser to a bypass request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the response to the bypass request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the bypass request.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who reviewed the bypass request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the bypass request." + } + } + }, + "status": { + "type": "string", + "description": "The response status to the bypass request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the bypass request was created." + } + } + } + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/1" + ] + }, + "html_url": { + "type": "string", + "description": "The URL to view the dismissal request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/octo-org/smile/security/secret-scanning/17" + ] + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets a specific request to dismiss a secret scanning alert in a repository.
\nDelegated alert dismissal must be enabled on the repository and the user must be an org admin, security manager,\nor have the \"Review and manage secret scanning alert dismissal requests\" permission to access this endpoint.\nPersonal access tokens (classic) need the security_events
scope to use this endpoint.
A single dismissal request.
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}", + "title": "Review an alert dismissal request for secret scanning", + "category": "secret-scanning", + "subcategory": "alert-dismissal-requests", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git
extension. The name is not case sensitive.
The number that identifies the secret scanning alert in a repository.
", + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "status", + "in": "body", + "description": "The review action to perform on the dismissal request.
", + "isRequired": true, + "enum": [ + "approve", + "deny" + ] + }, + { + "type": "string", + "name": "message", + "in": "body", + "description": "A message to include with the review. Has a maximum character length of 2048.
", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secret scanning alerts\" repository permissions": "read", + "\"Contents\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "status": "deny", + "message": "This secret has not been revoked." + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "alert_number": "ALERT_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "The review of the dismissal request.
", + "example": { + "dismissal_review_id": 1 + }, + "schema": { + "type": "object", + "properties": { + "dismissal_review_id": { + "type": "integer", + "description": "ID of the dismissal review." + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Approve or deny a request to dismiss a secret scanning alert in a repository.
\nDelegated alert dismissal must be enabled on the repository and the user must be an org admin, security manager,\nor have the \"Review and manage secret scanning alert dismissal requests\" permission to access this endpoint.\nPersonal access tokens (classic) need the security_events
scope to use this endpoint.
The review of the dismissal request.
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + } + ], "delegated-bypass": [ { "serverUrl": "https://api.github.com", 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 5835e8e90c8e..985a206b2118 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 @@ -140606,7 +140606,7 @@ } ], "previews": [], - "descriptionHTML": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run
webhook event with the action rerequested
. When a check run is rerequested
, its status
is reset to queued
and the conclusion
is cleared.
For more information about how to re-run GitHub Actions jobs, see \"Re-run a job from a workflow run\".
\nOAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run
webhook event with the action rerequested
. When a check run is rerequested
, the status
of the check suite it belongs to is reset to queued
and the conclusion
is cleared. The check run itself is not updated. GitHub apps recieving the check_run
webhook with the rerequested
action should then decide if the check run should be reset or updated and call the update check_run
endpoint to update the check_run if desired.
For more information about how to re-run GitHub Actions jobs, see \"Re-run a job from a workflow run\".
\nOAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "201", @@ -199630,6 +199630,7 @@ "cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8", "cool": "https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8", "cop": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", + "copilot": "https://github.githubassets.com/images/icons/emoji/copilot.png?v8", "copyright": "https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8", "corn": "https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8", "costa_rica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8", 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 75058078eda3..cf83250d87d3 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 @@ -140750,7 +140750,7 @@ } ], "previews": [], - "descriptionHTML": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run
webhook event with the action rerequested
. When a check run is rerequested
, its status
is reset to queued
and the conclusion
is cleared.
For more information about how to re-run GitHub Actions jobs, see \"Re-run a job from a workflow run\".
\nOAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run
webhook event with the action rerequested
. When a check run is rerequested
, the status
of the check suite it belongs to is reset to queued
and the conclusion
is cleared. The check run itself is not updated. GitHub apps recieving the check_run
webhook with the rerequested
action should then decide if the check run should be reset or updated and call the update check_run
endpoint to update the check_run if desired.
For more information about how to re-run GitHub Actions jobs, see \"Re-run a job from a workflow run\".
\nOAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "201", @@ -199774,6 +199774,7 @@ "cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8", "cool": "https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8", "cop": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", + "copilot": "https://github.githubassets.com/images/icons/emoji/copilot.png?v8", "copyright": "https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8", "corn": "https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8", "costa_rica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8", diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index f0b4e47c1256..ae92a137daff 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -140750,7 +140750,7 @@ } ], "previews": [], - "descriptionHTML": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run
webhook event with the action rerequested
. When a check run is rerequested
, its status
is reset to queued
and the conclusion
is cleared.
For more information about how to re-run GitHub Actions jobs, see \"Re-run a job from a workflow run\".
\nOAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run
webhook event with the action rerequested
. When a check run is rerequested
, the status
of the check suite it belongs to is reset to queued
and the conclusion
is cleared. The check run itself is not updated. GitHub apps recieving the check_run
webhook with the rerequested
action should then decide if the check run should be reset or updated and call the update check_run
endpoint to update the check_run if desired.
For more information about how to re-run GitHub Actions jobs, see \"Re-run a job from a workflow run\".
\nOAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "201", @@ -199774,6 +199774,7 @@ "cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8", "cool": "https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8", "cop": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", + "copilot": "https://github.githubassets.com/images/icons/emoji/copilot.png?v8", "copyright": "https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8", "corn": "https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8", "costa_rica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8", diff --git a/src/rest/data/ghes-3.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json index a6beadb8b658..c5b7b75f471e 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json @@ -141334,7 +141334,7 @@ } ], "previews": [], - "descriptionHTML": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run
webhook event with the action rerequested
. When a check run is rerequested
, its status
is reset to queued
and the conclusion
is cleared.
For more information about how to re-run GitHub Actions jobs, see \"Re-run a job from a workflow run\".
\nOAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run
webhook event with the action rerequested
. When a check run is rerequested
, the status
of the check suite it belongs to is reset to queued
and the conclusion
is cleared. The check run itself is not updated. GitHub apps recieving the check_run
webhook with the rerequested
action should then decide if the check run should be reset or updated and call the update check_run
endpoint to update the check_run if desired.
For more information about how to re-run GitHub Actions jobs, see \"Re-run a job from a workflow run\".
\nOAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "201", @@ -203997,6 +203997,7 @@ "cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8", "cool": "https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8", "cop": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", + "copilot": "https://github.githubassets.com/images/icons/emoji/copilot.png?v8", "copyright": "https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8", "corn": "https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8", "costa_rica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8", @@ -503409,7 +503410,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", "required": false, "schema": { "type": "string" @@ -504825,7 +504826,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", "required": false, "schema": { "type": "string" @@ -506263,7 +506264,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", "required": false, "schema": { "type": "string" diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json index a904626852bb..7a0c255aa399 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json @@ -141432,7 +141432,7 @@ } ], "previews": [], - "descriptionHTML": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run
webhook event with the action rerequested
. When a check run is rerequested
, its status
is reset to queued
and the conclusion
is cleared.
For more information about how to re-run GitHub Actions jobs, see \"Re-run a job from a workflow run\".
\nOAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run
webhook event with the action rerequested
. When a check run is rerequested
, the status
of the check suite it belongs to is reset to queued
and the conclusion
is cleared. The check run itself is not updated. GitHub apps recieving the check_run
webhook with the rerequested
action should then decide if the check run should be reset or updated and call the update check_run
endpoint to update the check_run if desired.
For more information about how to re-run GitHub Actions jobs, see \"Re-run a job from a workflow run\".
\nOAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "201", @@ -207875,6 +207875,7 @@ "cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8", "cool": "https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8", "cop": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", + "copilot": "https://github.githubassets.com/images/icons/emoji/copilot.png?v8", "copyright": "https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8", "corn": "https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8", "costa_rica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8", @@ -386688,7 +386689,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nLists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Lists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.
\nOAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.
\nOAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Get the configuration of a single private registry defined for an organization, omitting its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nDelete a private registry configuration at the organization-level.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Delete a private registry configuration at the organization-level.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", "required": false, "schema": { "type": "string" @@ -511262,7 +511263,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", "required": false, "schema": { "type": "string" @@ -512928,7 +512929,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
", "required": false, "schema": { "type": "string" diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 1513356ed801..47cea04876fa 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -47,5 +47,5 @@ ] } }, - "sha": "c5cf21bd038d40077bcb9a9dffd0c8d0691c1d78" + "sha": "a3b90207333d17877bcbab612a4163337ed7148c" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 197b5438f7bc..8925ba5485df 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "c5cf21bd038d40077bcb9a9dffd0c8d0691c1d78" + "sha": "a3b90207333d17877bcbab612a4163337ed7148c" } \ No newline at end of file From 4f07ccdd02c36783c5d36587c66897f7e22551a3 Mon Sep 17 00:00:00 2001 From: Kevin Heis