From f4144ea4d6aaed0909cf55a9cdbfa053bcb3812b Mon Sep 17 00:00:00 2001 From: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Date: Mon, 31 Oct 2022 15:06:11 -0700 Subject: [PATCH] Update OpenAPI Descriptions (#32230) Co-authored-by: github-openapi-bot --- .../client-side-rest-api-redirects.json | 6 + lib/rest/static/decorated/api.github.com.json | 46 ++++++++ lib/rest/static/decorated/ghec.json | 46 ++++++++ lib/rest/static/decorated/github.ae.json | 34 ++++++ .../dereferenced/api.github.com.deref.json | 111 ++++++++++++++---- lib/rest/static/dereferenced/ghec.deref.json | 111 ++++++++++++++---- .../static/dereferenced/ghes-3.3.deref.json | 16 +++ .../static/dereferenced/ghes-3.4.deref.json | 16 +++ .../static/dereferenced/ghes-3.5.deref.json | 16 +++ .../static/dereferenced/ghes-3.6.deref.json | 16 +++ .../static/dereferenced/ghes-3.7.deref.json | 73 ++++++++---- .../static/dereferenced/github.ae.deref.json | 95 +++++++++++---- 12 files changed, 490 insertions(+), 96 deletions(-) diff --git a/lib/redirects/static/client-side-rest-api-redirects.json b/lib/redirects/static/client-side-rest-api-redirects.json index c8d9dca371..7821ca859c 100644 --- a/lib/redirects/static/client-side-rest-api-redirects.json +++ b/lib/redirects/static/client-side-rest-api-redirects.json @@ -846,6 +846,8 @@ "/rest/codespaces#get-a-codespace-for-the-authenticated-user": "/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user", "/rest/codespaces#update-a-codespace-for-the-authenticated-user": "/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user", "/rest/codespaces#delete-a-codespace-for-the-authenticated-user": "/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user", + "/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user": "/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user", + "/rest/codespaces/codespaces#get-details-about-a-codespace-export": "/rest/codespaces/codespaces#get-details-about-a-codespace-export", "/rest/codespaces#list-machine-types-for-a-codespace": "/rest/codespaces/machines#list-machine-types-for-a-codespace", "/rest/codespaces#start-a-codespace-for-the-authenticated-user": "/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user", "/rest/codespaces#stop-a-codespace-for-the-authenticated-user": "/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user", @@ -1005,6 +1007,10 @@ "/rest/apps#check-an-authorization": "/rest/apps/oauth-applications#check-an-authorization", "/rest/apps#reset-an-authorization": "/rest/apps/oauth-applications#reset-an-authorization", "/rest/apps#revoke-an-authorization-for-an-application": "/rest/apps/oauth-applications#revoke-an-authorization-for-an-application", + "/rest/enterprise-admin/announcement#get-the-global-announcement-banner": "/rest/enterprise-admin/announcement#get-the-global-announcement-banner", + "/rest/enterprise-admin#announcement": "/rest/enterprise-admin/announcement", + "/rest/enterprise-admin/announcement#set-the-global-announcement-banner": "/rest/enterprise-admin/announcement#set-the-global-announcement-banner", + "/rest/enterprise-admin/announcement#remove-the-global-announcement-banner": "/rest/enterprise-admin/announcement#remove-the-global-announcement-banner", "/rest/enterprise-admin#get-license-information": "/rest/enterprise-admin/license#get-license-information", "/rest/enterprise-admin#get-statistics": "/rest/enterprise-admin/admin-stats#get-statistics", "/rest/enterprise-admin#get-comment-statistics": "/rest/enterprise-admin/admin-stats#get-comment-statistics", diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index b40d14777a..c8d0d9784c 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -338449,6 +338449,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ @@ -338690,6 +338707,18 @@ "name": "secret_scanning_push_protection_enabled_for_new_repositories", "in": "body", "description": "

Whether secret scanning push protection is automatically enabled for new repositories.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + }, + { + "type": "boolean", + "name": "secret_scanning_push_protection_custom_link_enabled", + "in": "body", + "description": "

Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.

" + }, + { + "type": "string", + "name": "secret_scanning_push_protection_custom_link", + "in": "body", + "description": "

If secret_scanning_push_protection_custom_link_enabled is true, the URL that will be displayed to contributors who are blocked from pushing a secret.

" } ], "enabledForGitHubApps": true, @@ -339160,6 +339189,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ diff --git a/lib/rest/static/decorated/ghec.json b/lib/rest/static/decorated/ghec.json index 0e25325962..e0f21955e3 100644 --- a/lib/rest/static/decorated/ghec.json +++ b/lib/rest/static/decorated/ghec.json @@ -339834,6 +339834,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ @@ -340075,6 +340092,18 @@ "name": "secret_scanning_push_protection_enabled_for_new_repositories", "in": "body", "description": "

Whether secret scanning push protection is automatically enabled for new repositories.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + }, + { + "type": "boolean", + "name": "secret_scanning_push_protection_custom_link_enabled", + "in": "body", + "description": "

Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.

" + }, + { + "type": "string", + "name": "secret_scanning_push_protection_custom_link", + "in": "body", + "description": "

If secret_scanning_push_protection_custom_link_enabled is true, the URL that will be displayed to contributors who are blocked from pushing a secret.

" } ], "enabledForGitHubApps": true, @@ -340545,6 +340574,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 795989d7da..7b70a457dc 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -252115,6 +252115,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ @@ -252826,6 +252843,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index c7a6179db0..7db05f2096 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -56833,6 +56833,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ @@ -57111,6 +57128,14 @@ "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", "description": "Whether secret scanning push protection is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." + }, + "secret_scanning_push_protection_custom_link": { + "type": "string", + "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." } } }, @@ -57524,6 +57549,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ @@ -456369,6 +456411,10 @@ "codespaces" ], "operationId": "codespaces/export-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user" + }, "parameters": [ { "name": "codespace_name", @@ -456668,6 +456714,10 @@ "codespaces" ], "operationId": "codespaces/get-export-details-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export" + }, "parameters": [ { "name": "codespace_name", @@ -531074,6 +531124,10 @@ "meta" ], "operationId": "meta/get-zen", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/meta#get-the-zen-of-github" + }, "responses": { "200": { "description": "Response", @@ -537526,8 +537580,8 @@ }, "check-run-completed": { "post": { - "summary": "Check run completed", - "description": "The status of the check run is completed.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, see the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run was completed, and a conclusion is available.", "operationId": "check-run/completed", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run" @@ -537596,7 +537650,6 @@ "application/json": { "schema": { "title": "Check Run Completed Event", - "description": "The status of the check run is now `completed`.", "type": "object", "properties": { "action": { @@ -542029,7 +542082,7 @@ }, "check-run-created": { "post": { - "summary": "Check run created", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, see the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "description": "A new check run was created.", "operationId": "check-run/created", "externalDocs": { @@ -542099,7 +542152,6 @@ "application/json": { "schema": { "title": "Check Run Created Event", - "description": "A new check run was created.", "type": "object", "properties": { "action": { @@ -546532,7 +546584,8 @@ }, "check-suite-completed": { "post": { - "summary": "Check suite completed", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, see the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "All check runs in a check suite have completed, and a conclusion is available.", "operationId": "check-suite/completed", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" @@ -563115,7 +563168,8 @@ }, "commit-comment-created": { "post": { - "summary": "Commit comment created", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, see the `pull_request_review_comment` event. For activity relating to issue comments, see the `issue_comment` event. For activity relating to discussion comments, see the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "Someone commented on a commit.", "operationId": "commit-comment/created", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#commit-comment" @@ -563184,7 +563238,6 @@ "application/json": { "schema": { "title": "commit_comment created event", - "description": "A commit comment is created. The type of activity is specified in the `action` property. ", "type": "object", "properties": { "action": { @@ -582189,7 +582242,8 @@ }, "deploy-key-created": { "post": { - "summary": "Deploy key created", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/rest/deploy-keys)\" in the REST API documentation.", + "description": "A deploy key was created.", "operationId": "deploy-key/created", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" @@ -584181,7 +584235,8 @@ }, "deploy-key-deleted": { "post": { - "summary": "Deploy key deleted", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see \"[the GraphQL documentation](https://docs.github.com/graphql/reference/objects#deploykey)\" and \"[Deploy keys](https://docs.github.com/rest/deploy-keys)\" in the REST API documentation.", + "description": "A deploy key was deleted.", "operationId": "deploy-key/deleted", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" @@ -750186,7 +750241,8 @@ }, "member-added": { "post": { - "summary": "Member added", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A GitHub user accepted an invitation to a repository.", "operationId": "member/added", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -750255,7 +750311,6 @@ "application/json": { "schema": { "title": "member added event", - "description": "Activity related to repository collaborators. The type of activity is specified in the action property.", "type": "object", "properties": { "action": { @@ -752248,7 +752303,8 @@ }, "member-edited": { "post": { - "summary": "Member edited", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "Permissions were changed for a collaborator on a repository.", "operationId": "member/edited", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -754324,7 +754380,8 @@ }, "member-removed": { "post": { - "summary": "Member removed", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", "operationId": "member/removed", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -756364,7 +756421,8 @@ }, "membership-added": { "post": { - "summary": "Membership added", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was added to a team.", "operationId": "membership/added", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" @@ -758482,7 +758540,8 @@ }, "membership-removed": { "post": { - "summary": "Membership removed", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", "operationId": "membership/removed", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" @@ -760601,8 +760660,8 @@ }, "merge-group-checks-requested": { "post": { - "summary": "Status checks requested for a merge group", - "description": "This event occurs when status checks are requested for a merge group. This typically happens when a merge group is formed by the merge queue because a pull request was queued.\nWhen you receive this event, you'll be expected to perform checks on the head SHA and report status back using check runs or commit statuses.", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.\n\n**Note**: The pull request merge queue feature is currently in limited private beta and subject to change.", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", "operationId": "merge-group/checks-requested", "tags": [ "merge-queue" @@ -799469,8 +799528,7 @@ }, "ping": { "post": { - "summary": "Ping event", - "description": "When you create a new webhook, we'll send you a simple ping event to let you know you've set up the webhook correctly. This event isn't stored so it isn't retrievable via the Events API endpoint.", + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", "operationId": "ping", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#ping" @@ -799538,7 +799596,6 @@ "content": { "application/json": { "schema": { - "description": "The webhooks ping payload", "type": "object", "properties": { "hook": { @@ -1055930,7 +1055987,8 @@ }, "security-advisory-performed": { "post": { - "summary": "Security advisory performed", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A security advisory was published to the GitHub community, the metadata or description of a security advisory was changed, or the security advisory was withdrawn.", "operationId": "security-advisory/performed", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" @@ -1058031,7 +1058089,8 @@ }, "security-advisory-published": { "post": { - "summary": "Security advisory published", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A security advisory was published to the GitHub community.", "operationId": "security-advisory/published", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" @@ -1060132,7 +1060191,8 @@ }, "security-advisory-updated": { "post": { - "summary": "Security advisory updated", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "The metadata or description of a security advisory was changed, or the security advisory was withdrawn.", "operationId": "security-advisory/updated", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" @@ -1062233,7 +1062293,8 @@ }, "security-advisory-withdrawn": { "post": { - "summary": "Security advisory withdrawn", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A previously published security advisory was withdrawn.", "operationId": "security-advisory/withdrawn", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" diff --git a/lib/rest/static/dereferenced/ghec.deref.json b/lib/rest/static/dereferenced/ghec.deref.json index c38443c241..6b5b145742 100644 --- a/lib/rest/static/dereferenced/ghec.deref.json +++ b/lib/rest/static/dereferenced/ghec.deref.json @@ -57844,6 +57844,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ @@ -58122,6 +58139,14 @@ "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", "description": "Whether secret scanning push protection is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." + }, + "secret_scanning_push_protection_custom_link": { + "type": "string", + "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." } } }, @@ -58535,6 +58560,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ @@ -464083,6 +464125,10 @@ "codespaces" ], "operationId": "codespaces/export-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user" + }, "parameters": [ { "name": "codespace_name", @@ -464382,6 +464428,10 @@ "codespaces" ], "operationId": "codespaces/get-export-details-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export" + }, "parameters": [ { "name": "codespace_name", @@ -538788,6 +538838,10 @@ "meta" ], "operationId": "meta/get-zen", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/meta#get-the-zen-of-github" + }, "responses": { "200": { "description": "Response", @@ -545240,8 +545294,8 @@ }, "check-run-completed": { "post": { - "summary": "Check run completed", - "description": "The status of the check run is completed.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, see the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run was completed, and a conclusion is available.", "operationId": "check-run/completed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run" @@ -545310,7 +545364,6 @@ "application/json": { "schema": { "title": "Check Run Completed Event", - "description": "The status of the check run is now `completed`.", "type": "object", "properties": { "action": { @@ -549743,7 +549796,7 @@ }, "check-run-created": { "post": { - "summary": "Check run created", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, see the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "description": "A new check run was created.", "operationId": "check-run/created", "externalDocs": { @@ -549813,7 +549866,6 @@ "application/json": { "schema": { "title": "Check Run Created Event", - "description": "A new check run was created.", "type": "object", "properties": { "action": { @@ -554246,7 +554298,8 @@ }, "check-suite-completed": { "post": { - "summary": "Check suite completed", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, see the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "All check runs in a check suite have completed, and a conclusion is available.", "operationId": "check-suite/completed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" @@ -570829,7 +570882,8 @@ }, "commit-comment-created": { "post": { - "summary": "Commit comment created", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, see the `pull_request_review_comment` event. For activity relating to issue comments, see the `issue_comment` event. For activity relating to discussion comments, see the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "Someone commented on a commit.", "operationId": "commit-comment/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#commit-comment" @@ -570898,7 +570952,6 @@ "application/json": { "schema": { "title": "commit_comment created event", - "description": "A commit comment is created. The type of activity is specified in the `action` property. ", "type": "object", "properties": { "action": { @@ -589903,7 +589956,8 @@ }, "deploy-key-created": { "post": { - "summary": "Deploy key created", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.", + "description": "A deploy key was created.", "operationId": "deploy-key/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" @@ -591895,7 +591949,8 @@ }, "deploy-key-deleted": { "post": { - "summary": "Deploy key deleted", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see \"[the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey)\" and \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.", + "description": "A deploy key was deleted.", "operationId": "deploy-key/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" @@ -757900,7 +757955,8 @@ }, "member-added": { "post": { - "summary": "Member added", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A GitHub user accepted an invitation to a repository.", "operationId": "member/added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -757969,7 +758025,6 @@ "application/json": { "schema": { "title": "member added event", - "description": "Activity related to repository collaborators. The type of activity is specified in the action property.", "type": "object", "properties": { "action": { @@ -759962,7 +760017,8 @@ }, "member-edited": { "post": { - "summary": "Member edited", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "Permissions were changed for a collaborator on a repository.", "operationId": "member/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -762038,7 +762094,8 @@ }, "member-removed": { "post": { - "summary": "Member removed", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", "operationId": "member/removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -764078,7 +764135,8 @@ }, "membership-added": { "post": { - "summary": "Membership added", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was added to a team.", "operationId": "membership/added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" @@ -766196,7 +766254,8 @@ }, "membership-removed": { "post": { - "summary": "Membership removed", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", "operationId": "membership/removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" @@ -768315,8 +768374,8 @@ }, "merge-group-checks-requested": { "post": { - "summary": "Status checks requested for a merge group", - "description": "This event occurs when status checks are requested for a merge group. This typically happens when a merge group is formed by the merge queue because a pull request was queued.\nWhen you receive this event, you'll be expected to perform checks on the head SHA and report status back using check runs or commit statuses.", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.\n\n**Note**: The pull request merge queue feature is currently in limited private beta and subject to change.", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", "operationId": "merge-group/checks-requested", "tags": [ "merge-queue" @@ -807183,8 +807242,7 @@ }, "ping": { "post": { - "summary": "Ping event", - "description": "When you create a new webhook, we'll send you a simple ping event to let you know you've set up the webhook correctly. This event isn't stored so it isn't retrievable via the Events API endpoint.", + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", "operationId": "ping", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#ping" @@ -807252,7 +807310,6 @@ "content": { "application/json": { "schema": { - "description": "The webhooks ping payload", "type": "object", "properties": { "hook": { @@ -1063644,7 +1063701,8 @@ }, "security-advisory-performed": { "post": { - "summary": "Security advisory performed", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A security advisory was published to the GitHub community, the metadata or description of a security advisory was changed, or the security advisory was withdrawn.", "operationId": "security-advisory/performed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" @@ -1065745,7 +1065803,8 @@ }, "security-advisory-published": { "post": { - "summary": "Security advisory published", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A security advisory was published to the GitHub community.", "operationId": "security-advisory/published", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" @@ -1067846,7 +1067905,8 @@ }, "security-advisory-updated": { "post": { - "summary": "Security advisory updated", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "The metadata or description of a security advisory was changed, or the security advisory was withdrawn.", "operationId": "security-advisory/updated", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" @@ -1069947,7 +1070007,8 @@ }, "security-advisory-withdrawn": { "post": { - "summary": "Security advisory withdrawn", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A previously published security advisory was withdrawn.", "operationId": "security-advisory/withdrawn", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index 0de3783c26..60fb9de0c2 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -29784,6 +29784,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/get-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.3/rest/enterprise-admin/announcement#get-the-global-announcement-banner" + }, "responses": { "200": { "description": "Response", @@ -29848,6 +29852,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/set-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.3/rest/enterprise-admin/announcement#set-the-global-announcement-banner" + }, "requestBody": { "required": true, "content": { @@ -29950,6 +29958,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/remove-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.3/rest/enterprise-admin/announcement#remove-the-global-announcement-banner" + }, "responses": { "204": { "description": "Response" @@ -441468,6 +441480,10 @@ "meta" ], "operationId": "meta/get-zen", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.3/rest/meta#get-the-zen-of-github" + }, "responses": { "200": { "description": "Response", diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json index 9f85c305da..2a12c323e9 100644 --- a/lib/rest/static/dereferenced/ghes-3.4.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json @@ -27779,6 +27779,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/get-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.4/rest/enterprise-admin/announcement#get-the-global-announcement-banner" + }, "responses": { "200": { "description": "Response", @@ -27843,6 +27847,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/set-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.4/rest/enterprise-admin/announcement#set-the-global-announcement-banner" + }, "requestBody": { "required": true, "content": { @@ -27945,6 +27953,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/remove-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.4/rest/enterprise-admin/announcement#remove-the-global-announcement-banner" + }, "responses": { "204": { "description": "Response" @@ -461942,6 +461954,10 @@ "meta" ], "operationId": "meta/get-zen", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.4/rest/meta#get-the-zen-of-github" + }, "responses": { "200": { "description": "Response", diff --git a/lib/rest/static/dereferenced/ghes-3.5.deref.json b/lib/rest/static/dereferenced/ghes-3.5.deref.json index e307cb4005..7805d2607b 100644 --- a/lib/rest/static/dereferenced/ghes-3.5.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.5.deref.json @@ -27779,6 +27779,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/get-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.5/rest/enterprise-admin/announcement#get-the-global-announcement-banner" + }, "responses": { "200": { "description": "Response", @@ -27843,6 +27847,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/set-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.5/rest/enterprise-admin/announcement#set-the-global-announcement-banner" + }, "requestBody": { "required": true, "content": { @@ -27945,6 +27953,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/remove-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.5/rest/enterprise-admin/announcement#remove-the-global-announcement-banner" + }, "responses": { "204": { "description": "Response" @@ -469837,6 +469849,10 @@ "meta" ], "operationId": "meta/get-zen", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.5/rest/meta#get-the-zen-of-github" + }, "responses": { "200": { "description": "Response", diff --git a/lib/rest/static/dereferenced/ghes-3.6.deref.json b/lib/rest/static/dereferenced/ghes-3.6.deref.json index 892d7443fb..a0a258ebde 100644 --- a/lib/rest/static/dereferenced/ghes-3.6.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.6.deref.json @@ -27861,6 +27861,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/get-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.6/rest/enterprise-admin/announcement#get-the-global-announcement-banner" + }, "responses": { "200": { "description": "Response", @@ -27925,6 +27929,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/set-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.6/rest/enterprise-admin/announcement#set-the-global-announcement-banner" + }, "requestBody": { "required": true, "content": { @@ -28027,6 +28035,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/remove-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.6/rest/enterprise-admin/announcement#remove-the-global-announcement-banner" + }, "responses": { "204": { "description": "Response" @@ -485587,6 +485599,10 @@ "meta" ], "operationId": "meta/get-zen", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.6/rest/meta#get-the-zen-of-github" + }, "responses": { "200": { "description": "Response", diff --git a/lib/rest/static/dereferenced/ghes-3.7.deref.json b/lib/rest/static/dereferenced/ghes-3.7.deref.json index 82e688900d..167276d5d7 100644 --- a/lib/rest/static/dereferenced/ghes-3.7.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.7.deref.json @@ -27882,6 +27882,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/get-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.7/rest/enterprise-admin/announcement#get-the-global-announcement-banner" + }, "responses": { "200": { "description": "Response", @@ -27946,6 +27950,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/set-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.7/rest/enterprise-admin/announcement#set-the-global-announcement-banner" + }, "requestBody": { "required": true, "content": { @@ -28048,6 +28056,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/remove-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.7/rest/enterprise-admin/announcement#remove-the-global-announcement-banner" + }, "responses": { "204": { "description": "Response" @@ -490245,6 +490257,10 @@ "meta" ], "operationId": "meta/get-zen", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.7/rest/meta#get-the-zen-of-github" + }, "responses": { "200": { "description": "Response", @@ -498709,8 +498725,8 @@ }, "check-run-completed": { "post": { - "summary": "Check run completed", - "description": "The status of the check run is completed.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.7/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.7/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, see the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run was completed, and a conclusion is available.", "operationId": "check-run/completed", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run" @@ -498795,7 +498811,6 @@ "application/json": { "schema": { "title": "Check Run Completed Event", - "description": "The status of the check run is now `completed`.", "type": "object", "properties": { "action": { @@ -503228,7 +503243,7 @@ }, "check-run-created": { "post": { - "summary": "Check run created", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.7/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.7/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, see the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "description": "A new check run was created.", "operationId": "check-run/created", "externalDocs": { @@ -503314,7 +503329,6 @@ "application/json": { "schema": { "title": "Check Run Created Event", - "description": "A new check run was created.", "type": "object", "properties": { "action": { @@ -507747,7 +507761,8 @@ }, "check-suite-completed": { "post": { - "summary": "Check suite completed", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.7/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.7/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, see the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "All check runs in a check suite have completed, and a conclusion is available.", "operationId": "check-suite/completed", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" @@ -524442,7 +524457,8 @@ }, "commit-comment-created": { "post": { - "summary": "Commit comment created", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-server@3.7/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, see the `pull_request_review_comment` event. For activity relating to issue comments, see the `issue_comment` event. For activity relating to discussion comments, see the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "Someone commented on a commit.", "operationId": "commit-comment/created", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#commit-comment" @@ -524527,7 +524543,6 @@ "application/json": { "schema": { "title": "commit_comment created event", - "description": "A commit comment is created. The type of activity is specified in the `action` property. ", "type": "object", "properties": { "action": { @@ -543644,7 +543659,8 @@ }, "deploy-key-created": { "post": { - "summary": "Deploy key created", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-server@3.7/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-server@3.7/rest/deploy-keys)\" in the REST API documentation.", + "description": "A deploy key was created.", "operationId": "deploy-key/created", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" @@ -545652,7 +545668,8 @@ }, "deploy-key-deleted": { "post": { - "summary": "Deploy key deleted", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-server@3.7/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see \"[the GraphQL documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#deploykey)\" and \"[Deploy keys](https://docs.github.com/enterprise-server@3.7/rest/deploy-keys)\" in the REST API documentation.", + "description": "A deploy key was deleted.", "operationId": "deploy-key/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" @@ -701610,7 +701627,8 @@ }, "member-added": { "post": { - "summary": "Member added", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.7/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.7/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A GitHub user accepted an invitation to a repository.", "operationId": "member/added", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -701695,7 +701713,6 @@ "application/json": { "schema": { "title": "member added event", - "description": "Activity related to repository collaborators. The type of activity is specified in the action property.", "type": "object", "properties": { "action": { @@ -703688,7 +703705,8 @@ }, "member-edited": { "post": { - "summary": "Member edited", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.7/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.7/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "Permissions were changed for a collaborator on a repository.", "operationId": "member/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -705780,7 +705798,8 @@ }, "member-removed": { "post": { - "summary": "Member removed", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.7/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.7/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", "operationId": "member/removed", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -707836,7 +707855,8 @@ }, "membership-added": { "post": { - "summary": "Membership added", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.7/organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-server@3.7/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was added to a team.", "operationId": "membership/added", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" @@ -709970,7 +709990,8 @@ }, "membership-removed": { "post": { - "summary": "Membership removed", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.7/organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-server@3.7/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", "operationId": "membership/removed", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" @@ -712105,8 +712126,8 @@ }, "merge-group-checks-requested": { "post": { - "summary": "Status checks requested for a merge group", - "description": "This event occurs when status checks are requested for a merge group. This typically happens when a merge group is formed by the merge queue because a pull request was queued.\nWhen you receive this event, you'll be expected to perform checks on the head SHA and report status back using check runs or commit statuses.", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-server@3.7/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.\n\n**Note**: The pull request merge queue feature is currently in limited private beta and subject to change.", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", "operationId": "merge-group/checks-requested", "tags": [ "merge-queue" @@ -747149,8 +747170,7 @@ }, "ping": { "post": { - "summary": "Ping event", - "description": "When you create a new webhook, we'll send you a simple ping event to let you know you've set up the webhook correctly. This event isn't stored so it isn't retrievable via the Events API endpoint.", + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", "operationId": "ping", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#ping" @@ -747234,7 +747254,6 @@ "content": { "application/json": { "schema": { - "description": "The webhooks ping payload", "type": "object", "properties": { "hook": { @@ -1006811,7 +1006830,8 @@ }, "security-advisory-performed": { "post": { - "summary": "Security advisory performed", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-server@3.7/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.7/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A security advisory was published to the GitHub community, the metadata or description of a security advisory was changed, or the security advisory was withdrawn.", "operationId": "security-advisory/performed", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" @@ -1008928,7 +1008948,8 @@ }, "security-advisory-published": { "post": { - "summary": "Security advisory published", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-server@3.7/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.7/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A security advisory was published to the GitHub community.", "operationId": "security-advisory/published", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" @@ -1011045,7 +1011066,8 @@ }, "security-advisory-updated": { "post": { - "summary": "Security advisory updated", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-server@3.7/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.7/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "The metadata or description of a security advisory was changed, or the security advisory was withdrawn.", "operationId": "security-advisory/updated", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" @@ -1013162,7 +1013184,8 @@ }, "security-advisory-withdrawn": { "post": { - "summary": "Security advisory withdrawn", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nFor more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-server@3.7/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see \"[SecurityAdvisory](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#securityadvisory)\" in the GraphQL documentation.\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.7/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A previously published security advisory was withdrawn.", "operationId": "security-advisory/withdrawn", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory" diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 22f6efb70c..d369483644 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -17079,6 +17079,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/get-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/enterprise-admin/announcement#get-the-global-announcement-banner" + }, "responses": { "200": { "description": "Response", @@ -17143,6 +17147,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/set-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/enterprise-admin/announcement#set-the-global-announcement-banner" + }, "requestBody": { "required": true, "content": { @@ -17245,6 +17253,10 @@ "enterprise-admin" ], "operationId": "enterprise-admin/remove-announcement", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/enterprise-admin/announcement#remove-the-global-announcement-banner" + }, "responses": { "204": { "description": "Response" @@ -45818,6 +45830,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ @@ -46509,6 +46538,23 @@ "examples": [ false ] + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] } }, "required": [ @@ -412710,6 +412756,10 @@ "meta" ], "operationId": "meta/get-zen", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/meta#get-the-zen-of-github" + }, "responses": { "200": { "description": "Response", @@ -418931,8 +418981,8 @@ }, "check-run-completed": { "post": { - "summary": "Check run completed", - "description": "The status of the check run is completed.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/github-ae@latest/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, see the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run was completed, and a conclusion is available.", "operationId": "check-run/completed", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run" @@ -419001,7 +419051,6 @@ "application/json": { "schema": { "title": "Check Run Completed Event", - "description": "The status of the check run is now `completed`.", "type": "object", "properties": { "action": { @@ -423357,7 +423406,7 @@ }, "check-run-created": { "post": { - "summary": "Check run created", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/github-ae@latest/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, see the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "description": "A new check run was created.", "operationId": "check-run/created", "externalDocs": { @@ -423427,7 +423476,6 @@ "application/json": { "schema": { "title": "Check Run Created Event", - "description": "A new check run was created.", "type": "object", "properties": { "action": { @@ -427783,7 +427831,8 @@ }, "check-suite-completed": { "post": { - "summary": "Check suite completed", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/github-ae@latest/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, see the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "All check runs in a check suite have completed, and a conclusion is available.", "operationId": "check-suite/completed", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" @@ -443827,7 +443876,8 @@ }, "commit-comment-created": { "post": { - "summary": "Commit comment created", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/github-ae@latest/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, see the `pull_request_review_comment` event. For activity relating to issue comments, see the `issue_comment` event. For activity relating to discussion comments, see the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "Someone commented on a commit.", "operationId": "commit-comment/created", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#commit-comment" @@ -443896,7 +443946,6 @@ "application/json": { "schema": { "title": "commit_comment created event", - "description": "A commit comment is created. The type of activity is specified in the `action` property. ", "type": "object", "properties": { "action": { @@ -462285,7 +462334,8 @@ }, "deploy-key-created": { "post": { - "summary": "Deploy key created", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/github-ae@latest/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/github-ae@latest/rest/deploy-keys)\" in the REST API documentation.", + "description": "A deploy key was created.", "operationId": "deploy-key/created", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" @@ -464200,7 +464250,8 @@ }, "deploy-key-deleted": { "post": { - "summary": "Deploy key deleted", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/github-ae@latest/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see \"[the GraphQL documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#deploykey)\" and \"[Deploy keys](https://docs.github.com/github-ae@latest/rest/deploy-keys)\" in the REST API documentation.", + "description": "A deploy key was deleted.", "operationId": "deploy-key/deleted", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" @@ -614766,7 +614817,8 @@ }, "member-added": { "post": { - "summary": "Member added", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/github-ae@latest/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/github-ae@latest/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A GitHub user accepted an invitation to a repository.", "operationId": "member/added", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -614835,7 +614887,6 @@ "application/json": { "schema": { "title": "member added event", - "description": "Activity related to repository collaborators. The type of activity is specified in the action property.", "type": "object", "properties": { "action": { @@ -616751,7 +616802,8 @@ }, "member-edited": { "post": { - "summary": "Member edited", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/github-ae@latest/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/github-ae@latest/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "Permissions were changed for a collaborator on a repository.", "operationId": "member/edited", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -618750,7 +618802,8 @@ }, "member-removed": { "post": { - "summary": "Member removed", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/github-ae@latest/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/github-ae@latest/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", "operationId": "member/removed", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" @@ -620713,7 +620766,8 @@ }, "membership-added": { "post": { - "summary": "Membership added", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/github-ae@latest/organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/github-ae@latest/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was added to a team.", "operationId": "membership/added", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" @@ -622754,7 +622808,8 @@ }, "membership-removed": { "post": { - "summary": "Membership removed", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/github-ae@latest/organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/github-ae@latest/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", "operationId": "membership/removed", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" @@ -624796,8 +624851,8 @@ }, "merge-group-checks-requested": { "post": { - "summary": "Status checks requested for a merge group", - "description": "This event occurs when status checks are requested for a merge group. This typically happens when a merge group is formed by the merge queue because a pull request was queued.\nWhen you receive this event, you'll be expected to perform checks on the head SHA and report status back using check runs or commit statuses.", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/github-ae@latest/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.\n\n**Note**: The pull request merge queue feature is currently in limited private beta and subject to change.", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", "operationId": "merge-group/checks-requested", "tags": [ "merge-queue" @@ -658352,8 +658407,7 @@ }, "ping": { "post": { - "summary": "Ping event", - "description": "When you create a new webhook, we'll send you a simple ping event to let you know you've set up the webhook correctly. This event isn't stored so it isn't retrievable via the Events API endpoint.", + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", "operationId": "ping", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#ping" @@ -658421,7 +658475,6 @@ "content": { "application/json": { "schema": { - "description": "The webhooks ping payload", "type": "object", "properties": { "hook": {