diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 38c685403..a6ac15d32 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -9110,7 +9110,7 @@ "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand code matching policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can configure and view details about the organization's Copilot Business subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -9167,7 +9167,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).\n\nOnly organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription.\nOnly organization owners can view assigned seats.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -9250,7 +9250,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -9350,7 +9350,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -9452,7 +9452,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -9552,7 +9552,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -12227,7 +12227,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOrganization owners can view GitHub Copilot seat assignment details for members in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -12336,7 +12336,7 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], @@ -15396,7 +15396,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -33222,11 +33224,18 @@ } }, { - "$ref": "#/components/parameters/since" + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } }, { "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -95362,6 +95371,62 @@ "updated_at" ] }, + "enterprise-team": { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "example": "disabled | all" + }, + "group_id": { + "nullable": true, + "type": "integer", + "example": 1 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/dc/teams/justice-league" + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "sync_to_organizations", + "name", + "html_url", + "slug", + "created_at", + "updated_at" + ] + }, "copilot-seat-details": { "title": "Copilot Business Seat Detail", "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", @@ -95383,11 +95448,24 @@ } ] }, + "organization": { + "type": "object", + "description": "The organization to which this seat belongs.", + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/organization-simple" + } + ] + }, "assigning_team": { - "description": "The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually.", + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", "oneOf": [ { "$ref": "#/components/schemas/team" + }, + { + "$ref": "#/components/schemas/enterprise-team" } ], "nullable": true @@ -96819,7 +96897,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index 4e78791e9..ea09e0a49 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -6595,12 +6595,12 @@ paths: **Note**: This endpoint is in beta and is subject to change. Gets information about an organization's Copilot subscription, including seat breakdown - and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. + and feature policies. To configure these settings, go to your organization's settings on GitHub.com. For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". - Only organization owners can configure and view details about the organization's Copilot Business subscription. + Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/get-copilot-organization-details @@ -6640,11 +6640,10 @@ paths: description: |- **Note**: This endpoint is in beta and is subject to change. - Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + Only organization owners can view assigned seats. - Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. - - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/list-copilot-seats @@ -6705,13 +6704,13 @@ paths: Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-teams @@ -6790,9 +6789,9 @@ paths: For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can cancel Copilot seats for their organization members. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-teams @@ -6868,13 +6867,13 @@ paths: Purchases a GitHub Copilot seat for each user specified. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-users @@ -6953,9 +6952,9 @@ paths: For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can cancel Copilot seats for their organization members. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-users @@ -8889,9 +8888,9 @@ paths: Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. - Organization owners can view GitHub Copilot seat assignment details for members in their organization. + Only organization owners can view Copilot seat assignment details for members of their organization. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/get-copilot-seat-details-for-user @@ -8972,10 +8971,10 @@ paths: the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email - will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user - is limited to 50 organization invitations per 24 hour period. If the organization - is more than one month old or on a paid plan, the limit is 500 invitations - per 24 hour period." + will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners + are limited to creating 50 organization invitations for an organization within + a 24 hour period. If the organization is more than one month old or on a paid + plan, the limit is 500 invitations per 24 hour period." tags: - orgs operationId: orgs/set-membership-for-user @@ -11187,6 +11186,8 @@ paths: enum: - string - single_select + - multi_select + - true_false description: The type of the value for the property required: type: boolean @@ -24087,10 +24088,22 @@ paths: required: false schema: type: string - - "$ref": "#/components/parameters/since" + - name: since + description: 'Only show results that were last updated after the given time. + This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must + be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may + be returned.' + in: query + required: false + schema: + type: string + format: date-time - name: until description: 'Only commits before this date will be returned. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 + (inclusive) or unexpected results may be returned.' in: query required: false schema: @@ -69377,6 +69390,49 @@ components: - type - created_at - updated_at + enterprise-team: + title: Enterprise Team + description: Group of enterprise owners and/or members + type: object + properties: + id: + type: integer + name: + type: string + slug: + type: string + url: + type: string + format: uri + sync_to_organizations: + type: string + example: disabled | all + group_id: + nullable: true + type: integer + example: 1 + html_url: + type: string + format: uri + example: https://github.com/enterprises/dc/teams/justice-league + members_url: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - url + - members_url + - sync_to_organizations + - name + - html_url + - slug + - created_at + - updated_at copilot-seat-details: title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, @@ -69391,11 +69447,18 @@ components: - "$ref": "#/components/schemas/simple-user" - "$ref": "#/components/schemas/team" - "$ref": "#/components/schemas/organization" + organization: + type: object + description: The organization to which this seat belongs. + nullable: true + oneOf: + - "$ref": "#/components/schemas/organization-simple" assigning_team: - description: The team that granted access to GitHub Copilot to the assignee. - This will be null if the user was assigned a seat individually. + description: The team through which the assignee is granted access to GitHub + Copilot, if applicable. oneOf: - "$ref": "#/components/schemas/team" + - "$ref": "#/components/schemas/enterprise-team" nullable: true pending_cancellation_date: type: string @@ -70522,6 +70585,8 @@ components: enum: - string - single_select + - multi_select + - true_false description: The type of the value for the property required: type: boolean diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 38c685403..a6ac15d32 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -9110,7 +9110,7 @@ "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand code matching policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can configure and view details about the organization's Copilot Business subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -9167,7 +9167,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).\n\nOnly organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription.\nOnly organization owners can view assigned seats.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -9250,7 +9250,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -9350,7 +9350,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -9452,7 +9452,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -9552,7 +9552,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -12227,7 +12227,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOrganization owners can view GitHub Copilot seat assignment details for members in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -12336,7 +12336,7 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], @@ -15396,7 +15396,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -33222,11 +33224,18 @@ } }, { - "$ref": "#/components/parameters/since" + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } }, { "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -95362,6 +95371,62 @@ "updated_at" ] }, + "enterprise-team": { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "example": "disabled | all" + }, + "group_id": { + "nullable": true, + "type": "integer", + "example": 1 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/dc/teams/justice-league" + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "sync_to_organizations", + "name", + "html_url", + "slug", + "created_at", + "updated_at" + ] + }, "copilot-seat-details": { "title": "Copilot Business Seat Detail", "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", @@ -95383,11 +95448,24 @@ } ] }, + "organization": { + "type": "object", + "description": "The organization to which this seat belongs.", + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/organization-simple" + } + ] + }, "assigning_team": { - "description": "The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually.", + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", "oneOf": [ { "$ref": "#/components/schemas/team" + }, + { + "$ref": "#/components/schemas/enterprise-team" } ], "nullable": true @@ -96819,7 +96897,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 4e78791e9..ea09e0a49 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -6595,12 +6595,12 @@ paths: **Note**: This endpoint is in beta and is subject to change. Gets information about an organization's Copilot subscription, including seat breakdown - and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. + and feature policies. To configure these settings, go to your organization's settings on GitHub.com. For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". - Only organization owners can configure and view details about the organization's Copilot Business subscription. + Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/get-copilot-organization-details @@ -6640,11 +6640,10 @@ paths: description: |- **Note**: This endpoint is in beta and is subject to change. - Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + Only organization owners can view assigned seats. - Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. - - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/list-copilot-seats @@ -6705,13 +6704,13 @@ paths: Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-teams @@ -6790,9 +6789,9 @@ paths: For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can cancel Copilot seats for their organization members. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-teams @@ -6868,13 +6867,13 @@ paths: Purchases a GitHub Copilot seat for each user specified. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-users @@ -6953,9 +6952,9 @@ paths: For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can cancel Copilot seats for their organization members. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-users @@ -8889,9 +8888,9 @@ paths: Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. - Organization owners can view GitHub Copilot seat assignment details for members in their organization. + Only organization owners can view Copilot seat assignment details for members of their organization. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/get-copilot-seat-details-for-user @@ -8972,10 +8971,10 @@ paths: the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email - will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user - is limited to 50 organization invitations per 24 hour period. If the organization - is more than one month old or on a paid plan, the limit is 500 invitations - per 24 hour period." + will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners + are limited to creating 50 organization invitations for an organization within + a 24 hour period. If the organization is more than one month old or on a paid + plan, the limit is 500 invitations per 24 hour period." tags: - orgs operationId: orgs/set-membership-for-user @@ -11187,6 +11186,8 @@ paths: enum: - string - single_select + - multi_select + - true_false description: The type of the value for the property required: type: boolean @@ -24087,10 +24088,22 @@ paths: required: false schema: type: string - - "$ref": "#/components/parameters/since" + - name: since + description: 'Only show results that were last updated after the given time. + This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must + be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may + be returned.' + in: query + required: false + schema: + type: string + format: date-time - name: until description: 'Only commits before this date will be returned. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 + (inclusive) or unexpected results may be returned.' in: query required: false schema: @@ -69377,6 +69390,49 @@ components: - type - created_at - updated_at + enterprise-team: + title: Enterprise Team + description: Group of enterprise owners and/or members + type: object + properties: + id: + type: integer + name: + type: string + slug: + type: string + url: + type: string + format: uri + sync_to_organizations: + type: string + example: disabled | all + group_id: + nullable: true + type: integer + example: 1 + html_url: + type: string + format: uri + example: https://github.com/enterprises/dc/teams/justice-league + members_url: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - url + - members_url + - sync_to_organizations + - name + - html_url + - slug + - created_at + - updated_at copilot-seat-details: title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, @@ -69391,11 +69447,18 @@ components: - "$ref": "#/components/schemas/simple-user" - "$ref": "#/components/schemas/team" - "$ref": "#/components/schemas/organization" + organization: + type: object + description: The organization to which this seat belongs. + nullable: true + oneOf: + - "$ref": "#/components/schemas/organization-simple" assigning_team: - description: The team that granted access to GitHub Copilot to the assignee. - This will be null if the user was assigned a seat individually. + description: The team through which the assignee is granted access to GitHub + Copilot, if applicable. oneOf: - "$ref": "#/components/schemas/team" + - "$ref": "#/components/schemas/enterprise-team" nullable: true pending_cancellation_date: type: string @@ -70522,6 +70585,8 @@ components: enum: - string - single_select + - multi_select + - true_false description: The type of the value for the property required: type: boolean diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 9cd44f417..7209afdfb 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -59843,7 +59843,7 @@ "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand code matching policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can configure and view details about the organization's Copilot Business subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -60097,7 +60097,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).\n\nOnly organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription.\nOnly organization owners can view assigned seats.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -60612,8 +60612,88 @@ } ] }, + "organization": { + "type": "object", + "description": "The organization to which this seat belongs.", + "nullable": true, + "oneOf": [ + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ] + }, "assigning_team": { - "description": "The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually.", + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", "oneOf": [ { "title": "Team", @@ -60786,6 +60866,62 @@ "slug", "parent" ] + }, + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "example": "disabled | all" + }, + "group_id": { + "nullable": true, + "type": "integer", + "example": 1 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/dc/teams/justice-league" + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "sync_to_organizations", + "name", + "html_url", + "slug", + "created_at", + "updated_at" + ] } ], "nullable": true @@ -61032,7 +61168,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -61230,7 +61366,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -61430,7 +61566,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -61628,7 +61764,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -81333,7 +81469,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOrganization owners can view GitHub Copilot seat assignment details for members in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -81830,8 +81966,88 @@ } ] }, + "organization": { + "type": "object", + "description": "The organization to which this seat belongs.", + "nullable": true, + "oneOf": [ + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ] + }, "assigning_team": { - "description": "The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually.", + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", "oneOf": [ { "title": "Team", @@ -82004,6 +82220,62 @@ "slug", "parent" ] + }, + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "example": "disabled | all" + }, + "group_id": { + "nullable": true, + "type": "integer", + "example": 1 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/dc/teams/justice-league" + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "sync_to_organizations", + "name", + "html_url", + "slug", + "created_at", + "updated_at" + ] } ], "nullable": true @@ -82602,7 +82874,7 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], @@ -98631,7 +98903,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -98822,7 +99096,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -98937,7 +99213,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -99134,7 +99412,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -99309,7 +99589,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -99388,7 +99670,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -213628,7 +213912,7 @@ }, { "name": "since", - "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -213638,7 +213922,7 @@ }, { "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -534292,7 +534576,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -535146,7 +535432,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 221f31ba4..f47fb4e9b 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -1428,7 +1428,7 @@ paths: schema: type: integer default: 30 - - &141 + - &142 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1449,7 +1449,7 @@ paths: application/json: schema: type: array - items: &142 + items: &143 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1526,7 +1526,7 @@ paths: - installation_id - repository_id examples: - default: &143 + default: &144 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1654,7 +1654,7 @@ paths: description: Response content: application/json: - schema: &144 + schema: &145 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1768,7 +1768,7 @@ paths: - request - response examples: - default: &145 + default: &146 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -6883,7 +6883,7 @@ paths: application/json: schema: type: array - items: &124 + items: &125 title: Copilot Usage Metrics description: Summary of Copilot usage. type: object @@ -7066,7 +7066,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *39 - - &125 + - &126 name: state in: query description: |- @@ -7075,7 +7075,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &126 + - &127 name: severity in: query description: |- @@ -7084,7 +7084,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &127 + - &128 name: ecosystem in: query description: |- @@ -7093,14 +7093,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &128 + - &129 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &129 + - &130 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -7110,7 +7110,7 @@ paths: enum: - development - runtime - - &130 + - &131 name: sort in: query description: |- @@ -7126,7 +7126,7 @@ paths: - *40 - *41 - *42 - - &131 + - &132 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -7139,7 +7139,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &132 + - &133 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -7159,7 +7159,7 @@ paths: application/json: schema: type: array - items: &133 + items: &134 type: object description: A Dependabot alert. properties: @@ -7774,7 +7774,7 @@ paths: - repository additionalProperties: false examples: - default: &134 + default: &135 value: - number: 2 state: dismissed @@ -11327,7 +11327,7 @@ paths: - closed - all default: open - - &152 + - &153 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -11378,7 +11378,7 @@ paths: type: array items: *69 examples: - default: &153 + default: &154 value: - id: 1 node_id: MDU6SXNzdWUx @@ -12871,7 +12871,7 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: &136 + properties: &137 id: type: integer example: 1296269 @@ -13186,7 +13186,7 @@ paths: enum: - enabled - disabled - required: &137 + required: &138 - archive_url - assignees_url - blobs_url @@ -13815,7 +13815,7 @@ paths: application/json: schema: type: array - items: &159 + items: &123 title: Organization Simple description: A GitHub organization. type: object @@ -17081,7 +17081,7 @@ paths: type: array items: *19 examples: - default: &154 + default: &155 value: - login: octocat id: 1 @@ -17717,7 +17717,7 @@ paths: type: integer codespaces: type: array - items: &155 + items: &156 type: object title: Codespace description: A codespace. @@ -17993,7 +17993,7 @@ paths: - pulls_url - recent_folders examples: - default: &156 + default: &157 value: total_count: 3 codespaces: @@ -19044,12 +19044,12 @@ paths: **Note**: This endpoint is in beta and is subject to change. Gets information about an organization's Copilot subscription, including seat breakdown - and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. + and feature policies. To configure these settings, go to your organization's settings on GitHub.com. For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". - Only organization owners can configure and view details about the organization's Copilot Business subscription. + Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/get-copilot-organization-details @@ -19172,11 +19172,10 @@ paths: description: |- **Note**: This endpoint is in beta and is subject to change. - Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). - - Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + Only organization owners can view assigned seats. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/list-copilot-seats @@ -19207,7 +19206,7 @@ paths: currently being billed. seats: type: array - items: &158 + items: &159 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -19220,7 +19219,7 @@ paths: additionalProperties: true oneOf: - *19 - - &123 + - &124 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -19483,12 +19482,59 @@ paths: - type - created_at - updated_at - assigning_team: - description: The team that granted access to GitHub Copilot - to the assignee. This will be null if the user was assigned - a seat individually. + organization: + type: object + description: The organization to which this seat belongs. + nullable: true oneOf: - *123 + assigning_team: + description: The team through which the assignee is granted + access to GitHub Copilot, if applicable. + oneOf: + - *124 + - title: Enterprise Team + description: Group of enterprise owners and/or members + type: object + properties: + id: + type: integer + name: + type: string + slug: + type: string + url: + type: string + format: uri + sync_to_organizations: + type: string + example: disabled | all + group_id: + nullable: true + type: integer + example: 1 + html_url: + type: string + format: uri + example: https://github.com/enterprises/dc/teams/justice-league + members_url: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - url + - members_url + - sync_to_organizations + - name + - html_url + - slug + - created_at + - updated_at nullable: true pending_cancellation_date: type: string @@ -19611,13 +19657,13 @@ paths: Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-teams @@ -19692,9 +19738,9 @@ paths: For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can cancel Copilot seats for their organization members. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-teams @@ -19766,13 +19812,13 @@ paths: Purchases a GitHub Copilot seat for each user specified. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-users @@ -19847,9 +19893,9 @@ paths: For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can cancel Copilot seats for their organization members. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-users @@ -19969,7 +20015,7 @@ paths: application/json: schema: type: array - items: *124 + items: *125 examples: default: value: @@ -20061,17 +20107,17 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *86 - - *125 - *126 - *127 - *128 - *129 - *130 + - *131 - *40 - *41 - *42 - - *131 - *132 + - *133 - *18 responses: '200': @@ -20080,9 +20126,9 @@ paths: application/json: schema: type: array - items: *133 + items: *134 examples: - default: *134 + default: *135 '304': *37 '400': *15 '403': *29 @@ -20126,7 +20172,7 @@ paths: type: integer secrets: type: array - items: &135 + items: &136 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -20250,7 +20296,7 @@ paths: description: Response content: application/json: - schema: *135 + schema: *136 examples: default: value: @@ -20597,8 +20643,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *136 - required: *137 + properties: *137 + required: *138 nullable: true created_at: type: string @@ -20782,7 +20828,7 @@ paths: application/json: schema: type: array - items: &149 + items: &150 title: Organization Invitation description: Organization Invitation type: object @@ -20828,7 +20874,7 @@ paths: - invitation_teams_url - node_id examples: - default: &150 + default: &151 value: - id: 1 login: monalisa @@ -20893,7 +20939,7 @@ paths: application/json: schema: type: array - items: &138 + items: &139 title: Org Hook description: Org Hook type: object @@ -21064,9 +21110,9 @@ paths: description: Response content: application/json: - schema: *138 + schema: *139 examples: - default: &139 + default: &140 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -21114,7 +21160,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - *86 - - &140 + - &141 name: hook_id description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. @@ -21127,9 +21173,9 @@ paths: description: Response content: application/json: - schema: *138 + schema: *139 examples: - default: *139 + default: *140 '404': *7 x-github: githubCloudOnly: false @@ -21157,7 +21203,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - *86 - - *140 + - *141 requestBody: required: false content: @@ -21202,7 +21248,7 @@ paths: description: Response content: application/json: - schema: *138 + schema: *139 examples: default: value: @@ -21242,7 +21288,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - *86 - - *140 + - *141 responses: '204': description: Response @@ -21270,7 +21316,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *86 - - *140 + - *141 responses: '200': description: Response @@ -21301,7 +21347,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *86 - - *140 + - *141 requestBody: required: false content: @@ -21352,9 +21398,9 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *86 - - *140 - - *18 - *141 + - *18 + - *142 - name: redelivery in: query required: false @@ -21367,9 +21413,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *143 + default: *144 '400': *15 '422': *16 x-github: @@ -21395,16 +21441,16 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *86 - - *140 + - *141 - *17 responses: '200': description: Response content: application/json: - schema: *144 + schema: *145 examples: - default: *145 + default: *146 '400': *15 '422': *16 x-github: @@ -21430,7 +21476,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *86 - - *140 + - *141 - *17 responses: '202': *91 @@ -21460,7 +21506,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - *86 - - *140 + - *141 responses: '204': description: Response @@ -21657,12 +21703,12 @@ paths: application/json: schema: anyOf: - - &147 + - &148 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &146 + limit: &147 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -21687,7 +21733,7 @@ paths: properties: {} additionalProperties: false examples: - default: &148 + default: &149 value: limit: collaborators_only origin: organization @@ -21722,7 +21768,7 @@ paths: duration type: object properties: - limit: *146 + limit: *147 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -21746,9 +21792,9 @@ paths: description: Response content: application/json: - schema: *147 + schema: *148 examples: - default: *148 + default: *149 '422': *16 x-github: githubCloudOnly: false @@ -21824,9 +21870,9 @@ paths: application/json: schema: type: array - items: *149 + items: *150 examples: - default: *150 + default: *151 headers: Link: *50 '404': *7 @@ -21903,7 +21949,7 @@ paths: description: Response content: application/json: - schema: *149 + schema: *150 examples: default: value: @@ -21958,7 +22004,7 @@ paths: url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - *86 - - &151 + - &152 name: invitation_id description: The unique identifier of the invitation. in: path @@ -21989,7 +22035,7 @@ paths: url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - *86 - - *151 + - *152 - *18 - *20 responses: @@ -21999,7 +22045,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: &168 value: @@ -22078,7 +22124,7 @@ paths: - closed - all default: open - - *152 + - *153 - name: sort description: What to sort results by. in: query @@ -22103,7 +22149,7 @@ paths: type: array items: *69 examples: - default: *153 + default: *154 headers: Link: *50 '404': *7 @@ -22161,7 +22207,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '422': *16 @@ -22257,9 +22303,9 @@ paths: type: integer codespaces: type: array - items: *155 + items: *156 examples: - default: *156 + default: *157 '304': *37 '500': *121 '401': *25 @@ -22286,7 +22332,7 @@ paths: parameters: - *86 - *114 - - &157 + - &158 name: codespace_name in: path required: true @@ -22321,13 +22367,13 @@ paths: parameters: - *86 - *114 - - *157 + - *158 responses: '200': description: Response content: application/json: - schema: *155 + schema: *156 examples: default: &341 value: @@ -22488,9 +22534,9 @@ paths: Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. - Organization owners can view GitHub Copilot seat assignment details for members in their organization. + Only organization owners can view Copilot seat assignment details for members of their organization. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/get-copilot-seat-details-for-user @@ -22505,7 +22551,7 @@ paths: description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *158 + schema: *159 examples: default: value: @@ -22608,7 +22654,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *159 + organization: *123 user: title: Simple User description: A GitHub user. @@ -22688,10 +22734,10 @@ paths: the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email - will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user - is limited to 50 organization invitations per 24 hour period. If the organization - is more than one month old or on a paid plan, the limit is 500 invitations - per 24 hour period." + will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners + are limited to creating 50 organization invitations for an organization within + a 24 hour period. If the organization is more than one month old or on a paid + plan, the limit is 500 invitations per 24 hour period." tags: - orgs operationId: orgs/set-membership-for-user @@ -24378,7 +24424,7 @@ paths: schema: type: array description: List of teams assigned to the organization role - items: *123 + items: *124 examples: default: *168 headers: @@ -24423,7 +24469,7 @@ paths: description: List of users assigned to the organization role items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '404': @@ -24471,7 +24517,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -26037,6 +26083,8 @@ paths: enum: - string - single_select + - multi_select + - true_false description: The type of the value for the property required: type: boolean @@ -26239,6 +26287,8 @@ paths: enum: - string - single_select + - multi_select + - true_false description: The type of the value for the property required: type: boolean @@ -26509,7 +26559,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -29713,7 +29763,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *123 + items: *124 private_fork: readOnly: true nullable: true @@ -30425,7 +30475,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 headers: @@ -32312,9 +32362,9 @@ paths: application/json: schema: type: array - items: *149 + items: *150 examples: - default: *150 + default: *151 headers: Link: *50 x-github: @@ -32360,7 +32410,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -33554,7 +33604,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: response-if-child-teams-exist: &535 value: @@ -34591,7 +34641,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '404': *7 @@ -39410,7 +39460,7 @@ paths: reviewer: anyOf: - *19 - - *123 + - *124 required: - environment - wait_timer @@ -40908,7 +40958,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '404': *7 @@ -41371,7 +41421,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *123 + items: *124 apps: description: The list of apps with review dismissal access. @@ -41400,7 +41450,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *123 + items: *124 apps: description: The list of apps allowed to bypass pull request requirements. @@ -42632,7 +42682,7 @@ paths: items: *19 teams: type: array - items: *123 + items: *124 apps: type: array items: *6 @@ -42650,7 +42700,7 @@ paths: items: *19 teams: type: array - items: *123 + items: *124 apps: type: array items: *6 @@ -44044,7 +44094,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 '404': *7 @@ -44104,7 +44154,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 '422': *16 @@ -44165,7 +44215,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 '422': *16 @@ -44225,7 +44275,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 '422': *16 @@ -44261,7 +44311,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '404': *7 x-github: githubCloudOnly: false @@ -44324,7 +44374,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '422': *16 x-github: githubCloudOnly: false @@ -44388,7 +44438,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '422': *16 x-github: githubCloudOnly: false @@ -44451,7 +44501,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '422': *16 x-github: githubCloudOnly: false @@ -49238,7 +49288,7 @@ paths: type: integer codespaces: type: array - items: *155 + items: *156 examples: default: value: @@ -49600,7 +49650,7 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *155 + schema: *156 examples: default: *341 '202': @@ -49608,7 +49658,7 @@ paths: being retried in the background content: application/json: - schema: *155 + schema: *156 examples: default: *341 '400': *15 @@ -51239,10 +51289,22 @@ paths: required: false schema: type: string - - *59 + - name: since + description: 'Only show results that were last updated after the given time. + This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must + be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may + be returned.' + in: query + required: false + schema: + type: string + format: date-time - name: until description: 'Only commits before this date will be returned. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 + (inclusive) or unexpected results may be returned.' in: query required: false schema: @@ -51698,7 +51760,7 @@ paths: nullable: true requested_teams: type: array - items: *123 + items: *124 nullable: true head: type: object @@ -54792,18 +54854,18 @@ paths: parameters: - *225 - *226 - - *125 - *126 - *127 - *128 + - *129 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *129 - *130 + - *131 - *40 - name: page description: "**Deprecated**. Page number of the results to fetch. Use cursor-based @@ -54823,8 +54885,8 @@ paths: default: 30 - *41 - *42 - - *131 - *132 + - *133 responses: '200': description: Response @@ -57101,7 +57163,7 @@ paths: reviewer: anyOf: - *19 - - *123 + - *124 required: - id - node_id @@ -60339,7 +60401,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '200': description: Response @@ -60369,7 +60431,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 requestBody: required: true content: @@ -60436,7 +60498,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '204': description: Response @@ -60462,7 +60524,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '200': description: Response @@ -60491,7 +60553,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 requestBody: required: false content: @@ -60537,9 +60599,9 @@ paths: parameters: - *225 - *226 - - *140 - - *18 - *141 + - *18 + - *142 - name: redelivery in: query required: false @@ -60552,9 +60614,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *143 + default: *144 '400': *15 '422': *16 x-github: @@ -60575,16 +60637,16 @@ paths: parameters: - *225 - *226 - - *140 + - *141 - *17 responses: '200': description: Response content: application/json: - schema: *144 + schema: *145 examples: - default: *145 + default: *146 '400': *15 '422': *16 x-github: @@ -60605,7 +60667,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 - *17 responses: '202': *91 @@ -60630,7 +60692,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '204': description: Response @@ -60656,7 +60718,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '204': description: Response @@ -61438,7 +61500,7 @@ paths: application/json: schema: anyOf: - - *147 + - *148 - type: object properties: {} additionalProperties: false @@ -61486,7 +61548,7 @@ paths: description: Response content: application/json: - schema: *147 + schema: *148 examples: default: *415 '409': @@ -61680,7 +61742,7 @@ paths: parameters: - *225 - *226 - - *151 + - *152 requestBody: required: false content: @@ -61842,7 +61904,7 @@ paths: parameters: - *225 - *226 - - *151 + - *152 responses: '204': description: Response @@ -61916,7 +61978,7 @@ paths: required: false schema: type: string - - *152 + - *153 - name: sort description: What to sort results by. in: query @@ -62829,7 +62891,7 @@ paths: properties: *4 required: *5 nullable: true - requested_team: *123 + requested_team: *124 dismissed_review: title: Issue Event Dismissed Review type: object @@ -64135,7 +64197,7 @@ paths: properties: *53 required: *54 review_requester: *19 - requested_team: *123 + requested_team: *124 requested_reviewer: *19 required: - review_requester @@ -64182,7 +64244,7 @@ paths: properties: *53 required: *54 review_requester: *19 - requested_team: *123 + requested_team: *124 requested_reviewer: *19 required: - review_requester @@ -71059,7 +71121,7 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *155 + schema: *156 examples: default: *341 '202': @@ -71067,7 +71129,7 @@ paths: being retried in the background content: application/json: - schema: *155 + schema: *156 examples: default: *341 '401': *25 @@ -71713,7 +71775,7 @@ paths: items: *19 teams: type: array - items: *123 + items: *124 required: - users - teams @@ -78033,7 +78095,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -78483,7 +78545,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 headers: @@ -82361,9 +82423,9 @@ paths: application/json: schema: type: array - items: *149 + items: *150 examples: - default: *150 + default: *151 headers: Link: *50 x-github: @@ -82411,7 +82473,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '404': *7 @@ -83134,7 +83196,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: response-if-child-teams-exist: *535 headers: @@ -83605,7 +83667,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '304': *37 '404': *7 '403': *29 @@ -83729,9 +83791,9 @@ paths: type: integer codespaces: type: array - items: *155 + items: *156 examples: - default: *156 + default: *157 '304': *37 '500': *121 '401': *25 @@ -83870,7 +83932,7 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *155 + schema: *156 examples: default: *341 '202': @@ -83878,7 +83940,7 @@ paths: being retried in the background content: application/json: - schema: *155 + schema: *156 examples: default: *341 '401': *25 @@ -84563,13 +84625,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *157 + - *158 responses: '200': description: Response content: application/json: - schema: *155 + schema: *156 examples: default: *341 '304': *37 @@ -84597,7 +84659,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *157 + - *158 requestBody: required: false content: @@ -84627,7 +84689,7 @@ paths: description: Response content: application/json: - schema: *155 + schema: *156 examples: default: *341 '401': *25 @@ -84651,7 +84713,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *157 + - *158 responses: '202': *91 '304': *37 @@ -84680,7 +84742,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *157 + - *158 responses: '202': description: Response @@ -84759,7 +84821,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *157 + - *158 - name: export_id in: path required: true @@ -84795,7 +84857,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *157 + - *158 responses: '200': description: Response @@ -84842,7 +84904,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *157 + - *158 requestBody: required: true content: @@ -85671,13 +85733,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *157 + - *158 responses: '200': description: Response content: application/json: - schema: *155 + schema: *156 examples: default: *341 '304': *37 @@ -85711,13 +85773,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *157 + - *158 responses: '200': description: Response content: application/json: - schema: *155 + schema: *156 examples: default: *341 '500': *121 @@ -86104,7 +86166,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '304': *37 @@ -86137,7 +86199,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '304': *37 @@ -86835,12 +86897,12 @@ paths: application/json: schema: anyOf: - - *147 + - *148 - type: object properties: {} additionalProperties: false examples: - default: *148 + default: *149 '204': description: Response when there are no restrictions x-github: @@ -86875,7 +86937,7 @@ paths: description: Response content: application/json: - schema: *147 + schema: *148 examples: default: value: @@ -86958,7 +87020,7 @@ paths: - closed - all default: open - - *152 + - *153 - name: sort description: What to sort results by. in: query @@ -86983,7 +87045,7 @@ paths: type: array items: *69 examples: - default: *153 + default: *154 headers: Link: *50 '404': *7 @@ -88406,7 +88468,7 @@ paths: application/json: schema: type: array - items: *159 + items: *123 examples: default: *553 headers: @@ -89420,7 +89482,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *151 + - *152 responses: '204': description: Response @@ -89443,7 +89505,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *151 + - *152 responses: '204': description: Response @@ -90224,7 +90286,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: example: ; rel="next" @@ -90643,7 +90705,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -90674,7 +90736,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -90946,7 +91008,7 @@ paths: application/json: schema: type: array - items: *159 + items: *123 examples: default: *553 headers: diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 9cd44f417..7209afdfb 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -59843,7 +59843,7 @@ "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand code matching policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can configure and view details about the organization's Copilot Business subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -60097,7 +60097,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).\n\nOnly organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription.\nOnly organization owners can view assigned seats.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -60612,8 +60612,88 @@ } ] }, + "organization": { + "type": "object", + "description": "The organization to which this seat belongs.", + "nullable": true, + "oneOf": [ + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ] + }, "assigning_team": { - "description": "The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually.", + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", "oneOf": [ { "title": "Team", @@ -60786,6 +60866,62 @@ "slug", "parent" ] + }, + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "example": "disabled | all" + }, + "group_id": { + "nullable": true, + "type": "integer", + "example": 1 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/dc/teams/justice-league" + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "sync_to_organizations", + "name", + "html_url", + "slug", + "created_at", + "updated_at" + ] } ], "nullable": true @@ -61032,7 +61168,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -61230,7 +61366,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -61430,7 +61566,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -61628,7 +61764,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -81333,7 +81469,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOrganization owners can view GitHub Copilot seat assignment details for members in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -81830,8 +81966,88 @@ } ] }, + "organization": { + "type": "object", + "description": "The organization to which this seat belongs.", + "nullable": true, + "oneOf": [ + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ] + }, "assigning_team": { - "description": "The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually.", + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", "oneOf": [ { "title": "Team", @@ -82004,6 +82220,62 @@ "slug", "parent" ] + }, + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "example": "disabled | all" + }, + "group_id": { + "nullable": true, + "type": "integer", + "example": 1 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/dc/teams/justice-league" + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "sync_to_organizations", + "name", + "html_url", + "slug", + "created_at", + "updated_at" + ] } ], "nullable": true @@ -82602,7 +82874,7 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], @@ -98631,7 +98903,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -98822,7 +99096,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -98937,7 +99213,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -99134,7 +99412,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -99309,7 +99589,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -99388,7 +99670,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -213628,7 +213912,7 @@ }, { "name": "since", - "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -213638,7 +213922,7 @@ }, { "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -534292,7 +534576,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -535146,7 +535432,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 221f31ba4..f47fb4e9b 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -1428,7 +1428,7 @@ paths: schema: type: integer default: 30 - - &141 + - &142 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1449,7 +1449,7 @@ paths: application/json: schema: type: array - items: &142 + items: &143 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1526,7 +1526,7 @@ paths: - installation_id - repository_id examples: - default: &143 + default: &144 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1654,7 +1654,7 @@ paths: description: Response content: application/json: - schema: &144 + schema: &145 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1768,7 +1768,7 @@ paths: - request - response examples: - default: &145 + default: &146 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -6883,7 +6883,7 @@ paths: application/json: schema: type: array - items: &124 + items: &125 title: Copilot Usage Metrics description: Summary of Copilot usage. type: object @@ -7066,7 +7066,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *39 - - &125 + - &126 name: state in: query description: |- @@ -7075,7 +7075,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &126 + - &127 name: severity in: query description: |- @@ -7084,7 +7084,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &127 + - &128 name: ecosystem in: query description: |- @@ -7093,14 +7093,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &128 + - &129 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &129 + - &130 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -7110,7 +7110,7 @@ paths: enum: - development - runtime - - &130 + - &131 name: sort in: query description: |- @@ -7126,7 +7126,7 @@ paths: - *40 - *41 - *42 - - &131 + - &132 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -7139,7 +7139,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &132 + - &133 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -7159,7 +7159,7 @@ paths: application/json: schema: type: array - items: &133 + items: &134 type: object description: A Dependabot alert. properties: @@ -7774,7 +7774,7 @@ paths: - repository additionalProperties: false examples: - default: &134 + default: &135 value: - number: 2 state: dismissed @@ -11327,7 +11327,7 @@ paths: - closed - all default: open - - &152 + - &153 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -11378,7 +11378,7 @@ paths: type: array items: *69 examples: - default: &153 + default: &154 value: - id: 1 node_id: MDU6SXNzdWUx @@ -12871,7 +12871,7 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: &136 + properties: &137 id: type: integer example: 1296269 @@ -13186,7 +13186,7 @@ paths: enum: - enabled - disabled - required: &137 + required: &138 - archive_url - assignees_url - blobs_url @@ -13815,7 +13815,7 @@ paths: application/json: schema: type: array - items: &159 + items: &123 title: Organization Simple description: A GitHub organization. type: object @@ -17081,7 +17081,7 @@ paths: type: array items: *19 examples: - default: &154 + default: &155 value: - login: octocat id: 1 @@ -17717,7 +17717,7 @@ paths: type: integer codespaces: type: array - items: &155 + items: &156 type: object title: Codespace description: A codespace. @@ -17993,7 +17993,7 @@ paths: - pulls_url - recent_folders examples: - default: &156 + default: &157 value: total_count: 3 codespaces: @@ -19044,12 +19044,12 @@ paths: **Note**: This endpoint is in beta and is subject to change. Gets information about an organization's Copilot subscription, including seat breakdown - and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. + and feature policies. To configure these settings, go to your organization's settings on GitHub.com. For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". - Only organization owners can configure and view details about the organization's Copilot Business subscription. + Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/get-copilot-organization-details @@ -19172,11 +19172,10 @@ paths: description: |- **Note**: This endpoint is in beta and is subject to change. - Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). - - Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + Only organization owners can view assigned seats. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/list-copilot-seats @@ -19207,7 +19206,7 @@ paths: currently being billed. seats: type: array - items: &158 + items: &159 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -19220,7 +19219,7 @@ paths: additionalProperties: true oneOf: - *19 - - &123 + - &124 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -19483,12 +19482,59 @@ paths: - type - created_at - updated_at - assigning_team: - description: The team that granted access to GitHub Copilot - to the assignee. This will be null if the user was assigned - a seat individually. + organization: + type: object + description: The organization to which this seat belongs. + nullable: true oneOf: - *123 + assigning_team: + description: The team through which the assignee is granted + access to GitHub Copilot, if applicable. + oneOf: + - *124 + - title: Enterprise Team + description: Group of enterprise owners and/or members + type: object + properties: + id: + type: integer + name: + type: string + slug: + type: string + url: + type: string + format: uri + sync_to_organizations: + type: string + example: disabled | all + group_id: + nullable: true + type: integer + example: 1 + html_url: + type: string + format: uri + example: https://github.com/enterprises/dc/teams/justice-league + members_url: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - url + - members_url + - sync_to_organizations + - name + - html_url + - slug + - created_at + - updated_at nullable: true pending_cancellation_date: type: string @@ -19611,13 +19657,13 @@ paths: Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-teams @@ -19692,9 +19738,9 @@ paths: For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can cancel Copilot seats for their organization members. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-teams @@ -19766,13 +19812,13 @@ paths: Purchases a GitHub Copilot seat for each user specified. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-users @@ -19847,9 +19893,9 @@ paths: For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can cancel Copilot seats for their organization members. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-users @@ -19969,7 +20015,7 @@ paths: application/json: schema: type: array - items: *124 + items: *125 examples: default: value: @@ -20061,17 +20107,17 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *86 - - *125 - *126 - *127 - *128 - *129 - *130 + - *131 - *40 - *41 - *42 - - *131 - *132 + - *133 - *18 responses: '200': @@ -20080,9 +20126,9 @@ paths: application/json: schema: type: array - items: *133 + items: *134 examples: - default: *134 + default: *135 '304': *37 '400': *15 '403': *29 @@ -20126,7 +20172,7 @@ paths: type: integer secrets: type: array - items: &135 + items: &136 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -20250,7 +20296,7 @@ paths: description: Response content: application/json: - schema: *135 + schema: *136 examples: default: value: @@ -20597,8 +20643,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *136 - required: *137 + properties: *137 + required: *138 nullable: true created_at: type: string @@ -20782,7 +20828,7 @@ paths: application/json: schema: type: array - items: &149 + items: &150 title: Organization Invitation description: Organization Invitation type: object @@ -20828,7 +20874,7 @@ paths: - invitation_teams_url - node_id examples: - default: &150 + default: &151 value: - id: 1 login: monalisa @@ -20893,7 +20939,7 @@ paths: application/json: schema: type: array - items: &138 + items: &139 title: Org Hook description: Org Hook type: object @@ -21064,9 +21110,9 @@ paths: description: Response content: application/json: - schema: *138 + schema: *139 examples: - default: &139 + default: &140 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -21114,7 +21160,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - *86 - - &140 + - &141 name: hook_id description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. @@ -21127,9 +21173,9 @@ paths: description: Response content: application/json: - schema: *138 + schema: *139 examples: - default: *139 + default: *140 '404': *7 x-github: githubCloudOnly: false @@ -21157,7 +21203,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - *86 - - *140 + - *141 requestBody: required: false content: @@ -21202,7 +21248,7 @@ paths: description: Response content: application/json: - schema: *138 + schema: *139 examples: default: value: @@ -21242,7 +21288,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - *86 - - *140 + - *141 responses: '204': description: Response @@ -21270,7 +21316,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *86 - - *140 + - *141 responses: '200': description: Response @@ -21301,7 +21347,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *86 - - *140 + - *141 requestBody: required: false content: @@ -21352,9 +21398,9 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *86 - - *140 - - *18 - *141 + - *18 + - *142 - name: redelivery in: query required: false @@ -21367,9 +21413,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *143 + default: *144 '400': *15 '422': *16 x-github: @@ -21395,16 +21441,16 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *86 - - *140 + - *141 - *17 responses: '200': description: Response content: application/json: - schema: *144 + schema: *145 examples: - default: *145 + default: *146 '400': *15 '422': *16 x-github: @@ -21430,7 +21476,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *86 - - *140 + - *141 - *17 responses: '202': *91 @@ -21460,7 +21506,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - *86 - - *140 + - *141 responses: '204': description: Response @@ -21657,12 +21703,12 @@ paths: application/json: schema: anyOf: - - &147 + - &148 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &146 + limit: &147 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -21687,7 +21733,7 @@ paths: properties: {} additionalProperties: false examples: - default: &148 + default: &149 value: limit: collaborators_only origin: organization @@ -21722,7 +21768,7 @@ paths: duration type: object properties: - limit: *146 + limit: *147 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -21746,9 +21792,9 @@ paths: description: Response content: application/json: - schema: *147 + schema: *148 examples: - default: *148 + default: *149 '422': *16 x-github: githubCloudOnly: false @@ -21824,9 +21870,9 @@ paths: application/json: schema: type: array - items: *149 + items: *150 examples: - default: *150 + default: *151 headers: Link: *50 '404': *7 @@ -21903,7 +21949,7 @@ paths: description: Response content: application/json: - schema: *149 + schema: *150 examples: default: value: @@ -21958,7 +22004,7 @@ paths: url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - *86 - - &151 + - &152 name: invitation_id description: The unique identifier of the invitation. in: path @@ -21989,7 +22035,7 @@ paths: url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - *86 - - *151 + - *152 - *18 - *20 responses: @@ -21999,7 +22045,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: &168 value: @@ -22078,7 +22124,7 @@ paths: - closed - all default: open - - *152 + - *153 - name: sort description: What to sort results by. in: query @@ -22103,7 +22149,7 @@ paths: type: array items: *69 examples: - default: *153 + default: *154 headers: Link: *50 '404': *7 @@ -22161,7 +22207,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '422': *16 @@ -22257,9 +22303,9 @@ paths: type: integer codespaces: type: array - items: *155 + items: *156 examples: - default: *156 + default: *157 '304': *37 '500': *121 '401': *25 @@ -22286,7 +22332,7 @@ paths: parameters: - *86 - *114 - - &157 + - &158 name: codespace_name in: path required: true @@ -22321,13 +22367,13 @@ paths: parameters: - *86 - *114 - - *157 + - *158 responses: '200': description: Response content: application/json: - schema: *155 + schema: *156 examples: default: &341 value: @@ -22488,9 +22534,9 @@ paths: Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. - Organization owners can view GitHub Copilot seat assignment details for members in their organization. + Only organization owners can view Copilot seat assignment details for members of their organization. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/get-copilot-seat-details-for-user @@ -22505,7 +22551,7 @@ paths: description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *158 + schema: *159 examples: default: value: @@ -22608,7 +22654,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *159 + organization: *123 user: title: Simple User description: A GitHub user. @@ -22688,10 +22734,10 @@ paths: the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email - will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user - is limited to 50 organization invitations per 24 hour period. If the organization - is more than one month old or on a paid plan, the limit is 500 invitations - per 24 hour period." + will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners + are limited to creating 50 organization invitations for an organization within + a 24 hour period. If the organization is more than one month old or on a paid + plan, the limit is 500 invitations per 24 hour period." tags: - orgs operationId: orgs/set-membership-for-user @@ -24378,7 +24424,7 @@ paths: schema: type: array description: List of teams assigned to the organization role - items: *123 + items: *124 examples: default: *168 headers: @@ -24423,7 +24469,7 @@ paths: description: List of users assigned to the organization role items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '404': @@ -24471,7 +24517,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -26037,6 +26083,8 @@ paths: enum: - string - single_select + - multi_select + - true_false description: The type of the value for the property required: type: boolean @@ -26239,6 +26287,8 @@ paths: enum: - string - single_select + - multi_select + - true_false description: The type of the value for the property required: type: boolean @@ -26509,7 +26559,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -29713,7 +29763,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *123 + items: *124 private_fork: readOnly: true nullable: true @@ -30425,7 +30475,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 headers: @@ -32312,9 +32362,9 @@ paths: application/json: schema: type: array - items: *149 + items: *150 examples: - default: *150 + default: *151 headers: Link: *50 x-github: @@ -32360,7 +32410,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -33554,7 +33604,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: response-if-child-teams-exist: &535 value: @@ -34591,7 +34641,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '404': *7 @@ -39410,7 +39460,7 @@ paths: reviewer: anyOf: - *19 - - *123 + - *124 required: - environment - wait_timer @@ -40908,7 +40958,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '404': *7 @@ -41371,7 +41421,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *123 + items: *124 apps: description: The list of apps with review dismissal access. @@ -41400,7 +41450,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *123 + items: *124 apps: description: The list of apps allowed to bypass pull request requirements. @@ -42632,7 +42682,7 @@ paths: items: *19 teams: type: array - items: *123 + items: *124 apps: type: array items: *6 @@ -42650,7 +42700,7 @@ paths: items: *19 teams: type: array - items: *123 + items: *124 apps: type: array items: *6 @@ -44044,7 +44094,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 '404': *7 @@ -44104,7 +44154,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 '422': *16 @@ -44165,7 +44215,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 '422': *16 @@ -44225,7 +44275,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 '422': *16 @@ -44261,7 +44311,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '404': *7 x-github: githubCloudOnly: false @@ -44324,7 +44374,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '422': *16 x-github: githubCloudOnly: false @@ -44388,7 +44438,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '422': *16 x-github: githubCloudOnly: false @@ -44451,7 +44501,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '422': *16 x-github: githubCloudOnly: false @@ -49238,7 +49288,7 @@ paths: type: integer codespaces: type: array - items: *155 + items: *156 examples: default: value: @@ -49600,7 +49650,7 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *155 + schema: *156 examples: default: *341 '202': @@ -49608,7 +49658,7 @@ paths: being retried in the background content: application/json: - schema: *155 + schema: *156 examples: default: *341 '400': *15 @@ -51239,10 +51289,22 @@ paths: required: false schema: type: string - - *59 + - name: since + description: 'Only show results that were last updated after the given time. + This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must + be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may + be returned.' + in: query + required: false + schema: + type: string + format: date-time - name: until description: 'Only commits before this date will be returned. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 + (inclusive) or unexpected results may be returned.' in: query required: false schema: @@ -51698,7 +51760,7 @@ paths: nullable: true requested_teams: type: array - items: *123 + items: *124 nullable: true head: type: object @@ -54792,18 +54854,18 @@ paths: parameters: - *225 - *226 - - *125 - *126 - *127 - *128 + - *129 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *129 - *130 + - *131 - *40 - name: page description: "**Deprecated**. Page number of the results to fetch. Use cursor-based @@ -54823,8 +54885,8 @@ paths: default: 30 - *41 - *42 - - *131 - *132 + - *133 responses: '200': description: Response @@ -57101,7 +57163,7 @@ paths: reviewer: anyOf: - *19 - - *123 + - *124 required: - id - node_id @@ -60339,7 +60401,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '200': description: Response @@ -60369,7 +60431,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 requestBody: required: true content: @@ -60436,7 +60498,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '204': description: Response @@ -60462,7 +60524,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '200': description: Response @@ -60491,7 +60553,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 requestBody: required: false content: @@ -60537,9 +60599,9 @@ paths: parameters: - *225 - *226 - - *140 - - *18 - *141 + - *18 + - *142 - name: redelivery in: query required: false @@ -60552,9 +60614,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *143 + default: *144 '400': *15 '422': *16 x-github: @@ -60575,16 +60637,16 @@ paths: parameters: - *225 - *226 - - *140 + - *141 - *17 responses: '200': description: Response content: application/json: - schema: *144 + schema: *145 examples: - default: *145 + default: *146 '400': *15 '422': *16 x-github: @@ -60605,7 +60667,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 - *17 responses: '202': *91 @@ -60630,7 +60692,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '204': description: Response @@ -60656,7 +60718,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '204': description: Response @@ -61438,7 +61500,7 @@ paths: application/json: schema: anyOf: - - *147 + - *148 - type: object properties: {} additionalProperties: false @@ -61486,7 +61548,7 @@ paths: description: Response content: application/json: - schema: *147 + schema: *148 examples: default: *415 '409': @@ -61680,7 +61742,7 @@ paths: parameters: - *225 - *226 - - *151 + - *152 requestBody: required: false content: @@ -61842,7 +61904,7 @@ paths: parameters: - *225 - *226 - - *151 + - *152 responses: '204': description: Response @@ -61916,7 +61978,7 @@ paths: required: false schema: type: string - - *152 + - *153 - name: sort description: What to sort results by. in: query @@ -62829,7 +62891,7 @@ paths: properties: *4 required: *5 nullable: true - requested_team: *123 + requested_team: *124 dismissed_review: title: Issue Event Dismissed Review type: object @@ -64135,7 +64197,7 @@ paths: properties: *53 required: *54 review_requester: *19 - requested_team: *123 + requested_team: *124 requested_reviewer: *19 required: - review_requester @@ -64182,7 +64244,7 @@ paths: properties: *53 required: *54 review_requester: *19 - requested_team: *123 + requested_team: *124 requested_reviewer: *19 required: - review_requester @@ -71059,7 +71121,7 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *155 + schema: *156 examples: default: *341 '202': @@ -71067,7 +71129,7 @@ paths: being retried in the background content: application/json: - schema: *155 + schema: *156 examples: default: *341 '401': *25 @@ -71713,7 +71775,7 @@ paths: items: *19 teams: type: array - items: *123 + items: *124 required: - users - teams @@ -78033,7 +78095,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -78483,7 +78545,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 headers: @@ -82361,9 +82423,9 @@ paths: application/json: schema: type: array - items: *149 + items: *150 examples: - default: *150 + default: *151 headers: Link: *50 x-github: @@ -82411,7 +82473,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '404': *7 @@ -83134,7 +83196,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: response-if-child-teams-exist: *535 headers: @@ -83605,7 +83667,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '304': *37 '404': *7 '403': *29 @@ -83729,9 +83791,9 @@ paths: type: integer codespaces: type: array - items: *155 + items: *156 examples: - default: *156 + default: *157 '304': *37 '500': *121 '401': *25 @@ -83870,7 +83932,7 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *155 + schema: *156 examples: default: *341 '202': @@ -83878,7 +83940,7 @@ paths: being retried in the background content: application/json: - schema: *155 + schema: *156 examples: default: *341 '401': *25 @@ -84563,13 +84625,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *157 + - *158 responses: '200': description: Response content: application/json: - schema: *155 + schema: *156 examples: default: *341 '304': *37 @@ -84597,7 +84659,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *157 + - *158 requestBody: required: false content: @@ -84627,7 +84689,7 @@ paths: description: Response content: application/json: - schema: *155 + schema: *156 examples: default: *341 '401': *25 @@ -84651,7 +84713,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *157 + - *158 responses: '202': *91 '304': *37 @@ -84680,7 +84742,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *157 + - *158 responses: '202': description: Response @@ -84759,7 +84821,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *157 + - *158 - name: export_id in: path required: true @@ -84795,7 +84857,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *157 + - *158 responses: '200': description: Response @@ -84842,7 +84904,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *157 + - *158 requestBody: required: true content: @@ -85671,13 +85733,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *157 + - *158 responses: '200': description: Response content: application/json: - schema: *155 + schema: *156 examples: default: *341 '304': *37 @@ -85711,13 +85773,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *157 + - *158 responses: '200': description: Response content: application/json: - schema: *155 + schema: *156 examples: default: *341 '500': *121 @@ -86104,7 +86166,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '304': *37 @@ -86137,7 +86199,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '304': *37 @@ -86835,12 +86897,12 @@ paths: application/json: schema: anyOf: - - *147 + - *148 - type: object properties: {} additionalProperties: false examples: - default: *148 + default: *149 '204': description: Response when there are no restrictions x-github: @@ -86875,7 +86937,7 @@ paths: description: Response content: application/json: - schema: *147 + schema: *148 examples: default: value: @@ -86958,7 +87020,7 @@ paths: - closed - all default: open - - *152 + - *153 - name: sort description: What to sort results by. in: query @@ -86983,7 +87045,7 @@ paths: type: array items: *69 examples: - default: *153 + default: *154 headers: Link: *50 '404': *7 @@ -88406,7 +88468,7 @@ paths: application/json: schema: type: array - items: *159 + items: *123 examples: default: *553 headers: @@ -89420,7 +89482,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *151 + - *152 responses: '204': description: Response @@ -89443,7 +89505,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *151 + - *152 responses: '204': description: Response @@ -90224,7 +90286,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: example: ; rel="next" @@ -90643,7 +90705,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -90674,7 +90736,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -90946,7 +91008,7 @@ paths: application/json: schema: type: array - items: *159 + items: *123 examples: default: *553 headers: diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index 9b4491620..c6af04da9 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -73114,7 +73114,7 @@ "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand code matching policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can configure and view details about the organization's Copilot Business subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -73368,7 +73368,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).\n\nOnly organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription.\nOnly organization owners can view assigned seats.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -73883,8 +73883,88 @@ } ] }, + "organization": { + "type": "object", + "description": "The organization to which this seat belongs.", + "nullable": true, + "oneOf": [ + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ] + }, "assigning_team": { - "description": "The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually.", + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", "oneOf": [ { "title": "Team", @@ -74057,6 +74137,62 @@ "slug", "parent" ] + }, + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "example": "disabled | all" + }, + "group_id": { + "nullable": true, + "type": "integer", + "example": 1 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/dc/teams/justice-league" + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "sync_to_organizations", + "name", + "html_url", + "slug", + "created_at", + "updated_at" + ] } ], "nullable": true @@ -74303,7 +74439,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -74501,7 +74637,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -74701,7 +74837,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -74899,7 +75035,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -97846,7 +97982,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOrganization owners can view GitHub Copilot seat assignment details for members in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -98343,8 +98479,88 @@ } ] }, + "organization": { + "type": "object", + "description": "The organization to which this seat belongs.", + "nullable": true, + "oneOf": [ + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ] + }, "assigning_team": { - "description": "The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually.", + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", "oneOf": [ { "title": "Team", @@ -98517,6 +98733,62 @@ "slug", "parent" ] + }, + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "example": "disabled | all" + }, + "group_id": { + "nullable": true, + "type": "integer", + "example": 1 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/dc/teams/justice-league" + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "sync_to_organizations", + "name", + "html_url", + "slug", + "created_at", + "updated_at" + ] } ], "nullable": true @@ -99115,7 +99387,7 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], @@ -115213,7 +115485,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -115404,7 +115678,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -115519,7 +115795,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -115716,7 +115994,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -115891,7 +116171,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -115970,7 +116252,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -231559,7 +231843,7 @@ }, { "name": "since", - "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -231569,7 +231853,7 @@ }, { "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -519654,7 +519938,8790 @@ }, "required": [ "action", - "repository", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_configuration", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "branch-protection-configuration-enabled": { + "post": { + "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "description": "All branch protections were enabled for a repository.", + "operationId": "branch-protection-configuration/enabled", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_configuration" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "branch protection configuration enabled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "enabled" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_configuration", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "branch-protection-rule-created": { + "post": { + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "description": "A branch protection rule was created.", + "operationId": "branch-protection-rule/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "branch protection rule created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "rule": { + "title": "branch protection rule", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "type": "object", + "properties": { + "admin_enforced": { + "type": "boolean" + }, + "allow_deletions_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "allow_force_pushes_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "authorized_actor_names": { + "type": "array", + "items": { + "type": "string" + } + }, + "authorized_actors_only": { + "type": "boolean" + }, + "authorized_dismissal_actors_only": { + "type": "boolean" + }, + "create_protected": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "ignore_approvals_from_contributors": { + "type": "boolean" + }, + "linear_history_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "merge_queue_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "name": { + "type": "string" + }, + "pull_request_reviews_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "repository_id": { + "type": "integer" + }, + "require_code_owner_review": { + "type": "boolean" + }, + "require_last_push_approval": { + "description": "Whether the most recent push must be approved by someone other than the person who pushed it", + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "required_conversation_resolution_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_deployments_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_status_checks": { + "type": "array", + "items": { + "type": "string" + } + }, + "required_status_checks_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "signature_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "strict_required_status_checks_policy": { + "type": "boolean" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "repository_id", + "name", + "created_at", + "updated_at", + "pull_request_reviews_enforcement_level", + "required_approving_review_count", + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "authorized_dismissal_actors_only", + "ignore_approvals_from_contributors", + "required_status_checks", + "required_status_checks_enforcement_level", + "strict_required_status_checks_policy", + "signature_requirement_enforcement_level", + "linear_history_requirement_enforcement_level", + "admin_enforced", + "allow_force_pushes_enforcement_level", + "allow_deletions_enforcement_level", + "merge_queue_enforcement_level", + "required_deployments_enforcement_level", + "required_conversation_resolution_level", + "authorized_actors_only", + "authorized_actor_names" + ] + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "rule", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_rule", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "branch-protection-rule-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "description": "A branch protection rule was deleted.", + "operationId": "branch-protection-rule/deleted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "branch protection rule deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "rule": { + "title": "branch protection rule", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "type": "object", + "properties": { + "admin_enforced": { + "type": "boolean" + }, + "allow_deletions_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "allow_force_pushes_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "authorized_actor_names": { + "type": "array", + "items": { + "type": "string" + } + }, + "authorized_actors_only": { + "type": "boolean" + }, + "authorized_dismissal_actors_only": { + "type": "boolean" + }, + "create_protected": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "ignore_approvals_from_contributors": { + "type": "boolean" + }, + "linear_history_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "merge_queue_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "name": { + "type": "string" + }, + "pull_request_reviews_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "repository_id": { + "type": "integer" + }, + "require_code_owner_review": { + "type": "boolean" + }, + "require_last_push_approval": { + "description": "Whether the most recent push must be approved by someone other than the person who pushed it", + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "required_conversation_resolution_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_deployments_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_status_checks": { + "type": "array", + "items": { + "type": "string" + } + }, + "required_status_checks_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "signature_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "strict_required_status_checks_policy": { + "type": "boolean" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "repository_id", + "name", + "created_at", + "updated_at", + "pull_request_reviews_enforcement_level", + "required_approving_review_count", + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "authorized_dismissal_actors_only", + "ignore_approvals_from_contributors", + "required_status_checks", + "required_status_checks_enforcement_level", + "strict_required_status_checks_policy", + "signature_requirement_enforcement_level", + "linear_history_requirement_enforcement_level", + "admin_enforced", + "allow_force_pushes_enforcement_level", + "allow_deletions_enforcement_level", + "merge_queue_enforcement_level", + "required_deployments_enforcement_level", + "required_conversation_resolution_level", + "authorized_actors_only", + "authorized_actor_names" + ] + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "rule", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_rule", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "branch-protection-rule-edited": { + "post": { + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "description": "A branch protection rule was edited.", + "operationId": "branch-protection-rule/edited", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "branch protection rule edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "description": "If the action was `edited`, the changes to the rule.", + "type": "object", + "properties": { + "admin_enforced": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "authorized_actor_names": { + "type": "object", + "properties": { + "from": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "from" + ] + }, + "authorized_actors_only": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "authorized_dismissal_actors_only": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "linear_history_requirement_enforcement_level": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + } + }, + "required": [ + "from" + ] + }, + "required_status_checks": { + "type": "object", + "properties": { + "from": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "from" + ] + }, + "required_status_checks_enforcement_level": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + } + }, + "required": [ + "from" + ] + } + } + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "rule": { + "title": "branch protection rule", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "type": "object", + "properties": { + "admin_enforced": { + "type": "boolean" + }, + "allow_deletions_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "allow_force_pushes_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "authorized_actor_names": { + "type": "array", + "items": { + "type": "string" + } + }, + "authorized_actors_only": { + "type": "boolean" + }, + "authorized_dismissal_actors_only": { + "type": "boolean" + }, + "create_protected": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "ignore_approvals_from_contributors": { + "type": "boolean" + }, + "linear_history_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "merge_queue_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "name": { + "type": "string" + }, + "pull_request_reviews_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "repository_id": { + "type": "integer" + }, + "require_code_owner_review": { + "type": "boolean" + }, + "require_last_push_approval": { + "description": "Whether the most recent push must be approved by someone other than the person who pushed it", + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "required_conversation_resolution_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_deployments_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_status_checks": { + "type": "array", + "items": { + "type": "string" + } + }, + "required_status_checks_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "signature_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "strict_required_status_checks_policy": { + "type": "boolean" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "repository_id", + "name", + "created_at", + "updated_at", + "pull_request_reviews_enforcement_level", + "required_approving_review_count", + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "authorized_dismissal_actors_only", + "ignore_approvals_from_contributors", + "required_status_checks", + "required_status_checks_enforcement_level", + "strict_required_status_checks_policy", + "signature_requirement_enforcement_level", + "linear_history_requirement_enforcement_level", + "admin_enforced", + "allow_force_pushes_enforcement_level", + "allow_deletions_enforcement_level", + "merge_queue_enforcement_level", + "required_deployments_enforcement_level", + "required_conversation_resolution_level", + "authorized_actors_only", + "authorized_actor_names" + ] + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "rule", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_rule", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-push-ruleset-cancelled": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A push ruleset bypass request was cancelled.", + "operationId": "exemption-request-push-ruleset/cancelled", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Exemption request cancellation event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "cancelled" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "example": "827efc6d56897b048c772eb4087f854f46256132" + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": "string", + "description": "The comment the requester provided when creating the exemption request.", + "nullable": true + }, + "metadata": { + "type": "object", + "description": "Metadata about the exemption request.", + "nullable": true, + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": "array", + "description": "The responses to the exemption request.", + "nullable": true, + "items": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "example": "https://github.com/monalisa/smile/exemptions/1" + } + } + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "exemption_request", "sender" ] } @@ -519669,7 +528736,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "branch_protection_configuration", + "subcategory": "bypass_request_push_ruleset", "supported-webhook-types": [ "repository", "organization", @@ -519678,13 +528745,13 @@ } } }, - "branch-protection-configuration-enabled": { + "bypass-request-push-ruleset-completed": { "post": { - "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "All branch protections were enabled for a repository.", - "operationId": "branch-protection-configuration/enabled", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A push ruleset bypass request was completed.", + "operationId": "exemption-request-push-ruleset/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_configuration" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" }, "parameters": [ { @@ -519749,13 +528816,13 @@ "content": { "application/json": { "schema": { - "title": "branch protection configuration enabled event", + "title": "Exemption request completed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "enabled" + "completed" ] }, "enterprise": { @@ -521126,6 +530193,219 @@ "updated_at" ] }, + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "example": "827efc6d56897b048c772eb4087f854f46256132" + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": "string", + "description": "The comment the requester provided when creating the exemption request.", + "nullable": true + }, + "metadata": { + "type": "object", + "description": "Metadata about the exemption request.", + "nullable": true, + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": "array", + "description": "The responses to the exemption request.", + "nullable": true, + "items": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "example": "https://github.com/monalisa/smile/exemptions/1" + } + } + }, "sender": { "title": "Simple User", "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", @@ -521248,7 +530528,7 @@ }, "required": [ "action", - "repository", + "exemption_request", "sender" ] } @@ -521263,7 +530543,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "branch_protection_configuration", + "subcategory": "bypass_request_push_ruleset", "supported-webhook-types": [ "repository", "organization", @@ -521272,13 +530552,13 @@ } } }, - "branch-protection-rule-created": { + "bypass-request-push-ruleset-created": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A branch protection rule was created.", - "operationId": "branch-protection-rule/created", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A push ruleset bypass request was created.", + "operationId": "exemption-request-push-ruleset/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" }, "parameters": [ { @@ -521343,7 +530623,7 @@ "content": { "application/json": { "schema": { - "title": "branch protection rule created event", + "title": "Exemption request created event", "type": "object", "properties": { "action": { @@ -522720,170 +532000,218 @@ "updated_at" ] }, - "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", "type": "object", "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } + "id": { + "type": "integer", + "description": "The ID of the exemption request." }, - "authorized_actors_only": { - "type": "boolean" + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." }, - "authorized_dismissal_actors_only": { - "type": "boolean" + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." }, - "create_protected": { - "type": "boolean" + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." }, - "created_at": { + "requester_login": { "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" + "description": "The login of the user who requested the exemption." }, - "linear_history_requirement_enforcement_level": { + "request_type": { "type": "string", + "description": "The type of request.", "enum": [ - "off", - "non_admins", - "everyone" + "push_ruleset_bypass", + "secret_scanning" ] }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } ] }, - "name": { - "type": "string" + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "example": "827efc6d56897b048c772eb4087f854f46256132" }, - "pull_request_reviews_enforcement_level": { + "status": { "type": "string", + "description": "The status of the exemption request.", "enum": [ - "off", - "non_admins", - "everyone" + "pending", + "rejected", + "cancelled", + "completed" ] }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" + "requester_comment": { + "type": "string", + "description": "The comment the requester provided when creating the exemption request.", + "nullable": true }, - "required_approving_review_count": { - "type": "integer" + "metadata": { + "type": "object", + "description": "Metadata about the exemption request.", + "nullable": true, + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] }, - "required_conversation_resolution_level": { + "expires_at": { "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] + "format": "date-time", + "description": "The date and time the exemption request will expire." }, - "required_deployments_enforcement_level": { + "created_at": { "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] + "format": "date-time", + "description": "The date and time the exemption request was created." }, - "required_status_checks": { + "responses": { "type": "array", + "description": "The responses to the exemption request.", + "nullable": true, "items": { - "type": "string" + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } } }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time" + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "example": "https://github.com/monalisa/smile/exemptions/1" } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + } }, "sender": { "title": "Simple User", @@ -523007,8 +532335,7 @@ }, "required": [ "action", - "rule", - "repository", + "exemption_request", "sender" ] } @@ -523023,7 +532350,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "branch_protection_rule", + "subcategory": "bypass_request_push_ruleset", "supported-webhook-types": [ "repository", "organization", @@ -523032,13 +532359,13 @@ } } }, - "branch-protection-rule-deleted": { + "bypass-request-push-ruleset-response-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A branch protection rule was deleted.", - "operationId": "branch-protection-rule/deleted", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A push ruleset bypass response was dismissed.", + "operationId": "exemption-request-push-ruleset/response-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" }, "parameters": [ { @@ -523103,13 +532430,13 @@ "content": { "application/json": { "schema": { - "title": "branch protection rule deleted event", + "title": "Exemption response dismissed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "response_dismissed" ] }, "enterprise": { @@ -524480,170 +533807,251 @@ "updated_at" ] }, - "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", "type": "object", "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } + "id": { + "type": "integer", + "description": "The ID of the exemption request." }, - "authorized_actors_only": { - "type": "boolean" + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." }, - "authorized_dismissal_actors_only": { - "type": "boolean" + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." }, - "create_protected": { - "type": "boolean" + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." }, - "created_at": { + "requester_login": { "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" + "description": "The login of the user who requested the exemption." }, - "linear_history_requirement_enforcement_level": { + "request_type": { "type": "string", + "description": "The type of request.", "enum": [ - "off", - "non_admins", - "everyone" + "push_ruleset_bypass", + "secret_scanning" ] }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } ] }, - "name": { - "type": "string" + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "example": "827efc6d56897b048c772eb4087f854f46256132" }, - "pull_request_reviews_enforcement_level": { + "status": { "type": "string", + "description": "The status of the exemption request.", "enum": [ - "off", - "non_admins", - "everyone" + "pending", + "rejected", + "cancelled", + "completed" ] }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" + "requester_comment": { + "type": "string", + "description": "The comment the requester provided when creating the exemption request.", + "nullable": true }, - "required_approving_review_count": { - "type": "integer" + "metadata": { + "type": "object", + "description": "Metadata about the exemption request.", + "nullable": true, + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] }, - "required_conversation_resolution_level": { + "expires_at": { "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] + "format": "date-time", + "description": "The date and time the exemption request will expire." }, - "required_deployments_enforcement_level": { + "created_at": { "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] + "format": "date-time", + "description": "The date and time the exemption request was created." }, - "required_status_checks": { + "responses": { "type": "array", + "description": "The responses to the exemption request.", + "nullable": true, "items": { - "type": "string" + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } } }, - "required_status_checks_enforcement_level": { + "html_url": { "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "example": "https://github.com/monalisa/smile/exemptions/1" + } + } + }, + "exemption_response": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." }, - "signature_requirement_enforcement_level": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { "type": "string", + "description": "The status of the exemption response.", "enum": [ - "off", - "non_admins", - "everyone" + "approved", + "rejected", + "dismissed" ] }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { + "created_at": { "type": "string", - "format": "date-time" + "format": "date-time", + "description": "The date and time the exemption request was created." } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + } }, "sender": { "title": "Simple User", @@ -524767,8 +534175,8 @@ }, "required": [ "action", - "rule", - "repository", + "exemption_request", + "exemption_response", "sender" ] } @@ -524783,7 +534191,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "branch_protection_rule", + "subcategory": "bypass_request_push_ruleset", "supported-webhook-types": [ "repository", "organization", @@ -524792,13 +534200,13 @@ } } }, - "branch-protection-rule-edited": { + "bypass-request-push-ruleset-response-submitted": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A branch protection rule was edited.", - "operationId": "branch-protection-rule/edited", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A response either approving or rejecting the push ruleset bypass request was submitted.", + "operationId": "exemption-request-push-ruleset/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" }, "parameters": [ { @@ -524863,117 +534271,15 @@ "content": { "application/json": { "schema": { - "title": "branch protection rule edited event", + "title": "Exemption response submitted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "response_submitted" ] }, - "changes": { - "description": "If the action was `edited`, the changes to the rule.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "object", - "properties": { - "from": { - "type": "boolean", - "nullable": true - } - }, - "required": [ - "from" - ] - }, - "authorized_actor_names": { - "type": "object", - "properties": { - "from": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "from" - ] - }, - "authorized_actors_only": { - "type": "object", - "properties": { - "from": { - "type": "boolean", - "nullable": true - } - }, - "required": [ - "from" - ] - }, - "authorized_dismissal_actors_only": { - "type": "object", - "properties": { - "from": { - "type": "boolean", - "nullable": true - } - }, - "required": [ - "from" - ] - }, - "linear_history_requirement_enforcement_level": { - "type": "object", - "properties": { - "from": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - } - }, - "required": [ - "from" - ] - }, - "required_status_checks": { - "type": "object", - "properties": { - "from": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "from" - ] - }, - "required_status_checks_enforcement_level": { - "type": "object", - "properties": { - "from": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - } - }, - "required": [ - "from" - ] - } - } - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", @@ -526342,170 +535648,251 @@ "updated_at" ] }, - "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", "type": "object", "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } + "id": { + "type": "integer", + "description": "The ID of the exemption request." }, - "authorized_actors_only": { - "type": "boolean" + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." }, - "authorized_dismissal_actors_only": { - "type": "boolean" + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." }, - "create_protected": { - "type": "boolean" + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." }, - "created_at": { + "requester_login": { "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" + "description": "The login of the user who requested the exemption." }, - "linear_history_requirement_enforcement_level": { + "request_type": { "type": "string", + "description": "The type of request.", "enum": [ - "off", - "non_admins", - "everyone" + "push_ruleset_bypass", + "secret_scanning" ] }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } ] }, - "name": { - "type": "string" + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "example": "827efc6d56897b048c772eb4087f854f46256132" }, - "pull_request_reviews_enforcement_level": { + "status": { "type": "string", + "description": "The status of the exemption request.", "enum": [ - "off", - "non_admins", - "everyone" + "pending", + "rejected", + "cancelled", + "completed" ] }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" + "requester_comment": { + "type": "string", + "description": "The comment the requester provided when creating the exemption request.", + "nullable": true }, - "required_approving_review_count": { - "type": "integer" + "metadata": { + "type": "object", + "description": "Metadata about the exemption request.", + "nullable": true, + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] }, - "required_conversation_resolution_level": { + "expires_at": { "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] + "format": "date-time", + "description": "The date and time the exemption request will expire." }, - "required_deployments_enforcement_level": { + "created_at": { "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] + "format": "date-time", + "description": "The date and time the exemption request was created." }, - "required_status_checks": { + "responses": { "type": "array", + "description": "The responses to the exemption request.", + "nullable": true, "items": { - "type": "string" + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } } }, - "required_status_checks_enforcement_level": { + "html_url": { "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "example": "https://github.com/monalisa/smile/exemptions/1" + } + } + }, + "exemption_response": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." }, - "signature_requirement_enforcement_level": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", "enum": [ - "off", - "non_admins", - "everyone" + "approved", + "rejected", + "dismissed" ] }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { + "created_at": { "type": "string", - "format": "date-time" + "format": "date-time", + "description": "The date and time the exemption request was created." } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + } }, "sender": { "title": "Simple User", @@ -526629,8 +536016,8 @@ }, "required": [ "action", - "rule", - "repository", + "exemption_request", + "exemption_response", "sender" ] } @@ -526645,7 +536032,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "branch_protection_rule", + "subcategory": "bypass_request_push_ruleset", "supported-webhook-types": [ "repository", "organization", @@ -572380,7 +581767,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -573234,7 +582623,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 52d78c037..b14080501 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -23535,12 +23535,12 @@ paths: **Note**: This endpoint is in beta and is subject to change. Gets information about an organization's Copilot subscription, including seat breakdown - and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. + and feature policies. To configure these settings, go to your organization's settings on GitHub.com. For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". - Only organization owners can configure and view details about the organization's Copilot Business subscription. + Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/get-copilot-organization-details @@ -23663,11 +23663,10 @@ paths: description: |- **Note**: This endpoint is in beta and is subject to change. - Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + Only organization owners can view assigned seats. - Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. - - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/list-copilot-seats @@ -23974,12 +23973,59 @@ paths: - type - created_at - updated_at + organization: + type: object + description: The organization to which this seat belongs. + nullable: true + oneOf: + - *52 assigning_team: - description: The team that granted access to GitHub Copilot - to the assignee. This will be null if the user was assigned - a seat individually. + description: The team through which the assignee is granted + access to GitHub Copilot, if applicable. oneOf: - *163 + - title: Enterprise Team + description: Group of enterprise owners and/or members + type: object + properties: + id: + type: integer + name: + type: string + slug: + type: string + url: + type: string + format: uri + sync_to_organizations: + type: string + example: disabled | all + group_id: + nullable: true + type: integer + example: 1 + html_url: + type: string + format: uri + example: https://github.com/enterprises/dc/teams/justice-league + members_url: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - url + - members_url + - sync_to_organizations + - name + - html_url + - slug + - created_at + - updated_at nullable: true pending_cancellation_date: type: string @@ -24102,13 +24148,13 @@ paths: Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-teams @@ -24183,9 +24229,9 @@ paths: For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can cancel Copilot seats for their organization members. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-teams @@ -24257,13 +24303,13 @@ paths: Purchases a GitHub Copilot seat for each user specified. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-users @@ -24338,9 +24384,9 @@ paths: For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can cancel Copilot seats for their organization members. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-users @@ -27890,9 +27936,9 @@ paths: Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. - Organization owners can view GitHub Copilot seat assignment details for members in their organization. + Only organization owners can view Copilot seat assignment details for members of their organization. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/get-copilot-seat-details-for-user @@ -28090,10 +28136,10 @@ paths: the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email - will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user - is limited to 50 organization invitations per 24 hour period. If the organization - is more than one month old or on a paid plan, the limit is 500 invitations - per 24 hour period." + will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners + are limited to creating 50 organization invitations for an organization within + a 24 hour period. If the organization is more than one month old or on a paid + plan, the limit is 500 invitations per 24 hour period." tags: - orgs operationId: orgs/set-membership-for-user @@ -31435,6 +31481,8 @@ paths: enum: - string - single_select + - multi_select + - true_false description: The type of the value for the property required: type: boolean @@ -31637,6 +31685,8 @@ paths: enum: - string - single_select + - multi_select + - true_false description: The type of the value for the property required: type: boolean @@ -50685,7 +50735,7 @@ paths: check. type: array items: *351 - deployment: &650 + deployment: &655 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -51595,7 +51645,7 @@ paths: type: string format: date-time nullable: true - head_commit: &676 + head_commit: &681 title: Simple Commit description: A commit. type: object @@ -56912,10 +56962,22 @@ paths: required: false schema: type: string - - *90 + - name: since + description: 'Only show results that were last updated after the given time. + This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must + be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may + be returned.' + in: query + required: false + schema: + type: string + format: date-time - name: until description: 'Only commits before this date will be returned. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 + (inclusive) or unexpected results may be returned.' in: query required: false schema: @@ -65833,7 +65895,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &684 + last_response: &689 title: Hook Response type: object properties: @@ -81763,7 +81825,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &702 + items: &707 type: object properties: type: @@ -99718,7 +99780,7 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &678 + properties: &683 id: description: Unique identifier of the repository example: 42 @@ -100400,7 +100462,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &679 + required: &684 - archive_url - assignees_url - blobs_url @@ -101107,20 +101169,20 @@ x-webhooks: - repository - organization - app - bypass-request-secret-scanning-cancelled: + bypass-request-push-ruleset-cancelled: post: summary: |- - This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + This event occurs when there is activity related to a user's request to bypass a set of push rules. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - Note: Delegated bypass for push protection is currently in beta and subject to change. - description: A secret scanning push protection bypass request was cancelled. - operationId: exemption-request-secret-scanning/cancelled + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A push ruleset bypass request was cancelled. + operationId: exemption-request-push-ruleset/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset parameters: - name: User-Agent in: header @@ -101161,7 +101223,7 @@ x-webhooks: required: true content: application/json: - schema: + schema: &650 title: Exemption request cancellation event type: object properties: @@ -101355,25 +101417,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: bypass_request_secret_scanning + subcategory: bypass_request_push_ruleset supported-webhook-types: - repository - organization - app - bypass-request-secret-scanning-completed: + bypass-request-push-ruleset-completed: post: summary: |- - This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + This event occurs when there is activity related to a user's request to bypass a set of push rules. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - Note: Delegated bypass for push protection is currently in beta and subject to change. - description: A secret scanning bypass request was completed. - operationId: exemption-request-secret-scanning/completed + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A push ruleset bypass request was completed. + operationId: exemption-request-push-ruleset/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset parameters: - name: User-Agent in: header @@ -101414,7 +101476,7 @@ x-webhooks: required: true content: application/json: - schema: + schema: &651 title: Exemption request completed event type: object properties: @@ -101439,25 +101501,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: bypass_request_secret_scanning + subcategory: bypass_request_push_ruleset supported-webhook-types: - repository - organization - app - bypass-request-secret-scanning-created: + bypass-request-push-ruleset-created: post: summary: |- - This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + This event occurs when there is activity related to a user's request to bypass a set of push rules. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - Note: Delegated bypass for push protection is currently in beta and subject to change. - description: A secret scanning push protection bypass request was created. - operationId: exemption-request-secret-scanning/created + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A push ruleset bypass request was created. + operationId: exemption-request-push-ruleset/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset parameters: - name: User-Agent in: header @@ -101498,7 +101560,7 @@ x-webhooks: required: true content: application/json: - schema: + schema: &652 title: Exemption request created event type: object properties: @@ -101523,25 +101585,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: bypass_request_secret_scanning + subcategory: bypass_request_push_ruleset supported-webhook-types: - repository - organization - app - bypass-request-secret-scanning-response-dismissed: + bypass-request-push-ruleset-response-dismissed: post: summary: |- - This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + This event occurs when there is activity related to a user's request to bypass a set of push rules. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - Note: Delegated bypass for push protection is currently in beta and subject to change. - description: A secret scanning push protection bypass response was dismissed. - operationId: exemption-request-secret-scanning/response-dismissed + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A push ruleset bypass response was dismissed. + operationId: exemption-request-push-ruleset/response-dismissed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset parameters: - name: User-Agent in: header @@ -101582,7 +101644,7 @@ x-webhooks: required: true content: application/json: - schema: + schema: &653 title: Exemption response dismissed event type: object properties: @@ -101609,26 +101671,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: bypass_request_secret_scanning + subcategory: bypass_request_push_ruleset supported-webhook-types: - repository - organization - app - bypass-request-secret-scanning-response-submitted: + bypass-request-push-ruleset-response-submitted: post: summary: |- - This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + This event occurs when there is activity related to a user's request to bypass a set of push rules. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - Note: Delegated bypass for push protection is currently in beta and subject to change. - description: A response either approving or rejecting the secret scanning push - protection bypass request was submitted. - operationId: exemption-request-secret-scanning/response-submitted + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A response either approving or rejecting the push ruleset bypass + request was submitted. + operationId: exemption-request-push-ruleset/response-submitted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset parameters: - name: User-Agent in: header @@ -101669,7 +101731,7 @@ x-webhooks: required: true content: application/json: - schema: + schema: &654 title: Exemption response submitted event type: object properties: @@ -101693,6 +101755,342 @@ x-webhooks: '200': description: Return a 200 status to indicate that the data was received successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_push_ruleset + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-cancelled: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning push protection bypass request was cancelled. + operationId: exemption-request-secret-scanning/cancelled + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: *650 + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-completed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning bypass request was completed. + operationId: exemption-request-secret-scanning/completed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: *651 + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-created: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning push protection bypass request was created. + operationId: exemption-request-secret-scanning/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: *652 + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-response-dismissed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning push protection bypass response was dismissed. + operationId: exemption-request-secret-scanning/response-dismissed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: *653 + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-response-submitted: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A response either approving or rejecting the secret scanning push + protection bypass request was submitted. + operationId: exemption-request-secret-scanning/response-submitted + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: *654 + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully x-github: githubCloudOnly: false category: webhooks @@ -101765,7 +102163,7 @@ x-webhooks: type: string enum: - completed - check_run: &651 + check_run: &656 title: CheckRun description: A check performed on the code of a given code change type: object @@ -101866,7 +102264,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *650 + deployment: *655 details_url: example: https://example.com type: string @@ -102345,7 +102743,7 @@ x-webhooks: type: string enum: - created - check_run: *651 + check_run: *656 installation: *643 organization: *644 repository: *645 @@ -102743,7 +103141,7 @@ x-webhooks: type: string enum: - requested_action - check_run: *651 + check_run: *656 installation: *643 organization: *644 repository: *645 @@ -103150,7 +103548,7 @@ x-webhooks: type: string enum: - rerequested - check_run: *651 + check_run: *656 installation: *643 organization: *644 repository: *645 @@ -105750,7 +106148,7 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &652 + commit_oid: &657 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. @@ -105758,7 +106156,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - ref: &653 + ref: &658 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. @@ -106079,11 +106477,11 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *652 + commit_oid: *657 enterprise: *642 installation: *643 organization: *644 - ref: *653 + ref: *658 repository: *645 sender: *646 required: @@ -106340,11 +106738,11 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *652 + commit_oid: *657 enterprise: *642 installation: *643 organization: *644 - ref: *653 + ref: *658 repository: *645 sender: *646 required: @@ -106664,11 +107062,11 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *652 + commit_oid: *657 enterprise: *642 installation: *643 organization: *644 - ref: *653 + ref: *658 repository: *645 sender: *646 required: @@ -107161,11 +107559,11 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *652 + commit_oid: *657 enterprise: *642 installation: *643 organization: *644 - ref: *653 + ref: *658 repository: *645 sender: *646 required: @@ -107510,11 +107908,11 @@ x-webhooks: `main`). type: string organization: *644 - pusher_type: &654 + pusher_type: &659 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &655 + ref: &660 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -107943,8 +108341,8 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - pusher_type: *654 - ref: *655 + pusher_type: *659 + ref: *660 ref_type: description: The type of Git ref object deleted in the repository. type: string @@ -108632,7 +109030,7 @@ x-webhooks: - created enterprise: *642 installation: *643 - key: &656 + key: &661 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -108746,7 +109144,7 @@ x-webhooks: - deleted enterprise: *642 installation: *643 - key: *656 + key: *661 organization: *644 repository: *645 sender: *646 @@ -109310,7 +109708,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - workflow: &660 + workflow: &665 title: Workflow type: object nullable: true @@ -110109,7 +110507,7 @@ x-webhooks: type: string enum: - approved - approver: &657 + approver: &662 type: object properties: avatar_url: @@ -110154,7 +110552,7 @@ x-webhooks: installation: *643 organization: *644 repository: *645 - reviewers: &658 + reviewers: &663 type: array items: type: object @@ -110233,7 +110631,7 @@ x-webhooks: sender: *646 since: type: string - workflow_job_run: &659 + workflow_job_run: &664 type: object properties: conclusion: @@ -110956,18 +111354,18 @@ x-webhooks: type: string enum: - rejected - approver: *657 + approver: *662 comment: type: string enterprise: *642 installation: *643 organization: *644 repository: *645 - reviewers: *658 + reviewers: *663 sender: *646 since: type: string - workflow_job_run: *659 + workflow_job_run: *664 workflow_job_runs: type: array items: @@ -111669,7 +112067,7 @@ x-webhooks: installation: *643 organization: *644 repository: *645 - requestor: &665 + requestor: &670 title: User type: object nullable: true @@ -113549,7 +113947,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - workflow: *660 + workflow: *665 workflow_run: title: Deployment Workflow Run type: object @@ -114224,7 +114622,7 @@ x-webhooks: type: string enum: - answered - answer: &663 + answer: &668 type: object properties: author_association: @@ -114378,7 +114776,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &661 + discussion: &666 title: Discussion description: A Discussion in a repository. type: object @@ -114807,7 +115205,7 @@ x-webhooks: - from required: - category - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -114893,7 +115291,7 @@ x-webhooks: type: string enum: - closed - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -114978,7 +115376,7 @@ x-webhooks: type: string enum: - created - comment: &662 + comment: &667 type: object properties: author_association: @@ -115132,7 +115530,7 @@ x-webhooks: - updated_at - body - reactions - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -115218,8 +115616,8 @@ x-webhooks: type: string enum: - deleted - comment: *662 - discussion: *661 + comment: *667 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -115317,8 +115715,8 @@ x-webhooks: - from required: - body - comment: *662 - discussion: *661 + comment: *667 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -115405,7 +115803,7 @@ x-webhooks: type: string enum: - created - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -115490,7 +115888,7 @@ x-webhooks: type: string enum: - deleted - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -115593,7 +115991,7 @@ x-webhooks: type: string required: - from - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -115678,10 +116076,10 @@ x-webhooks: type: string enum: - labeled - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 - label: &664 + label: &669 title: Label type: object properties: @@ -115796,7 +116194,7 @@ x-webhooks: type: string enum: - locked - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -115881,7 +116279,7 @@ x-webhooks: type: string enum: - pinned - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -115966,7 +116364,7 @@ x-webhooks: type: string enum: - reopened - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -116054,12 +116452,12 @@ x-webhooks: changes: type: object properties: - new_discussion: *661 + new_discussion: *666 new_repository: *645 required: - new_discussion - new_repository - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -116145,8 +116543,8 @@ x-webhooks: type: string enum: - unanswered - discussion: *661 - old_answer: *663 + discussion: *666 + old_answer: *668 organization: *644 repository: *645 sender: *646 @@ -116229,10 +116627,10 @@ x-webhooks: type: string enum: - unlabeled - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 - label: *664 + label: *669 organization: *644 repository: *645 sender: *646 @@ -116316,7 +116714,7 @@ x-webhooks: type: string enum: - unlocked - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -116401,7 +116799,7 @@ x-webhooks: type: string enum: - unpinned - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -117401,7 +117799,7 @@ x-webhooks: enterprise: *642 installation: *22 organization: *644 - repositories: &666 + repositories: &671 description: An array of repository objects that the installation can access. type: array @@ -117428,7 +117826,7 @@ x-webhooks: - full_name - private repository: *645 - requester: *665 + requester: *670 sender: *646 required: - action @@ -117506,7 +117904,7 @@ x-webhooks: enterprise: *642 installation: *22 organization: *644 - repositories: *666 + repositories: *671 repository: *645 requester: nullable: true @@ -117586,7 +117984,7 @@ x-webhooks: enterprise: *642 installation: *22 organization: *644 - repositories: *666 + repositories: *671 repository: *645 requester: nullable: true @@ -117666,7 +118064,7 @@ x-webhooks: enterprise: *642 installation: *22 organization: *644 - repositories_added: &667 + repositories_added: &672 description: An array of repository objects, which were added to the installation. type: array @@ -117713,14 +118111,14 @@ x-webhooks: description: Whether the repository is private or public. type: boolean repository: *645 - repository_selection: &668 + repository_selection: &673 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *665 + requester: *670 sender: *646 required: - action @@ -117802,7 +118200,7 @@ x-webhooks: enterprise: *642 installation: *22 organization: *644 - repositories_added: *667 + repositories_added: *672 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -117830,8 +118228,8 @@ x-webhooks: - full_name - private repository: *645 - repository_selection: *668 - requester: *665 + repository_selection: *673 + requester: *670 sender: *646 required: - action @@ -117913,7 +118311,7 @@ x-webhooks: enterprise: *642 installation: *22 organization: *644 - repositories: *666 + repositories: *671 repository: *645 requester: nullable: true @@ -118176,7 +118574,7 @@ x-webhooks: enterprise: *642 installation: *22 organization: *644 - repositories: *666 + repositories: *671 repository: *645 requester: nullable: true @@ -119635,7 +120033,7 @@ x-webhooks: type: string enum: - deleted - comment: &669 + comment: &674 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -121002,7 +121400,7 @@ x-webhooks: type: string enum: - edited - changes: &694 + changes: &699 description: The changes to the comment. type: object properties: @@ -121014,7 +121412,7 @@ x-webhooks: type: string required: - from - comment: *669 + comment: *674 enterprise: *642 installation: *643 issue: @@ -122225,10 +122623,10 @@ x-webhooks: type: string enum: - assigned - assignee: *665 + assignee: *670 enterprise: *642 installation: *643 - issue: &672 + issue: &677 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -126176,7 +126574,7 @@ x-webhooks: url: type: string format: uri - milestone: &670 + milestone: &675 title: Milestone description: A collection of related issues and pull requests. type: object @@ -127308,7 +127706,7 @@ x-webhooks: - active_lock_reason - body - reactions - label: *664 + label: *669 organization: *644 repository: *645 sender: *646 @@ -128285,7 +128683,7 @@ x-webhooks: - active_lock_reason - body - reactions - label: *664 + label: *669 organization: *644 repository: *645 sender: *646 @@ -130233,7 +130631,7 @@ x-webhooks: url: type: string format: uri - milestone: *670 + milestone: *675 organization: *644 repository: *645 sender: *646 @@ -132644,7 +133042,7 @@ x-webhooks: - pinned enterprise: *642 installation: *643 - issue: &671 + issue: &676 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -135944,7 +136342,7 @@ x-webhooks: - new_repository enterprise: *642 installation: *643 - issue: *671 + issue: *676 organization: *644 repository: *645 sender: *646 @@ -136027,7 +136425,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &697 + assignee: &702 title: User type: object nullable: true @@ -136097,7 +136495,7 @@ x-webhooks: - id enterprise: *642 installation: *643 - issue: *672 + issue: *677 organization: *644 repository: *645 sender: *646 @@ -136180,8 +136578,8 @@ x-webhooks: - unlabeled enterprise: *642 installation: *643 - issue: *672 - label: *664 + issue: *677 + label: *669 organization: *644 repository: *645 sender: *646 @@ -137238,7 +137636,7 @@ x-webhooks: - unpinned enterprise: *642 installation: *643 - issue: *671 + issue: *676 organization: *644 repository: *645 sender: *646 @@ -137321,7 +137719,7 @@ x-webhooks: - created enterprise: *642 installation: *643 - label: *664 + label: *669 organization: *644 repository: *645 sender: *646 @@ -137403,7 +137801,7 @@ x-webhooks: - deleted enterprise: *642 installation: *643 - label: *664 + label: *669 organization: *644 repository: *645 sender: *646 @@ -137517,7 +137915,7 @@ x-webhooks: - from enterprise: *642 installation: *643 - label: *664 + label: *669 organization: *644 repository: *645 sender: *646 @@ -137603,7 +138001,7 @@ x-webhooks: type: string enterprise: *642 installation: *643 - marketplace_purchase: &673 + marketplace_purchase: &678 title: Marketplace Purchase type: object required: @@ -137687,7 +138085,7 @@ x-webhooks: unit_count: type: integer organization: *644 - previous_marketplace_purchase: &674 + previous_marketplace_purchase: &679 title: Marketplace Purchase type: object properties: @@ -137849,7 +138247,7 @@ x-webhooks: type: string enterprise: *642 installation: *643 - marketplace_purchase: *673 + marketplace_purchase: *678 organization: *644 previous_marketplace_purchase: title: Marketplace Purchase @@ -138017,7 +138415,7 @@ x-webhooks: type: string enterprise: *642 installation: *643 - marketplace_purchase: *673 + marketplace_purchase: *678 organization: *644 previous_marketplace_purchase: title: Marketplace Purchase @@ -138265,7 +138663,7 @@ x-webhooks: unit_count: type: integer organization: *644 - previous_marketplace_purchase: *674 + previous_marketplace_purchase: *679 repository: *645 sender: *646 required: @@ -138348,9 +138746,9 @@ x-webhooks: type: string enterprise: *642 installation: *643 - marketplace_purchase: *673 + marketplace_purchase: *678 organization: *644 - previous_marketplace_purchase: *674 + previous_marketplace_purchase: *679 repository: *645 sender: *646 required: @@ -138455,7 +138853,7 @@ x-webhooks: - to enterprise: *642 installation: *643 - member: *665 + member: *670 organization: *644 repository: *645 sender: *646 @@ -138559,7 +138957,7 @@ x-webhooks: nullable: true enterprise: *642 installation: *643 - member: *665 + member: *670 organization: *644 repository: *645 sender: *646 @@ -138642,7 +139040,7 @@ x-webhooks: - removed enterprise: *642 installation: *643 - member: *665 + member: *670 organization: *644 repository: *645 sender: *646 @@ -138724,7 +139122,7 @@ x-webhooks: - added enterprise: *642 installation: *643 - member: *665 + member: *670 organization: *644 repository: *645 scope: @@ -138800,7 +139198,7 @@ x-webhooks: required: - login - id - team: &675 + team: &680 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -138992,7 +139390,7 @@ x-webhooks: - removed enterprise: *642 installation: *643 - member: *665 + member: *670 organization: *644 repository: *645 scope: @@ -139069,7 +139467,7 @@ x-webhooks: required: - login - id - team: *675 + team: *680 required: - action - scope @@ -139152,7 +139550,7 @@ x-webhooks: enum: - checks_requested installation: *643 - merge_group: &677 + merge_group: &682 type: object title: Merge Group description: 'A group of pull requests that the merge queue has @@ -139173,7 +139571,7 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *676 + head_commit: *681 required: - head_sha - head_ref @@ -139268,7 +139666,7 @@ x-webhooks: - invalidated - dequeued installation: *643 - merge_group: *677 + merge_group: *682 organization: *644 repository: *645 sender: *646 @@ -139459,8 +139857,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *678 - required: *679 + properties: *683 + required: *684 nullable: true sender: *646 required: @@ -139543,7 +139941,7 @@ x-webhooks: - closed enterprise: *642 installation: *643 - milestone: *670 + milestone: *675 organization: *644 repository: *645 sender: *646 @@ -139626,7 +140024,7 @@ x-webhooks: - created enterprise: *642 installation: *643 - milestone: &680 + milestone: &685 title: Milestone description: A collection of related issues and pull requests. type: object @@ -139843,7 +140241,7 @@ x-webhooks: - deleted enterprise: *642 installation: *643 - milestone: *670 + milestone: *675 organization: *644 repository: *645 sender: *646 @@ -139957,7 +140355,7 @@ x-webhooks: - from enterprise: *642 installation: *643 - milestone: *670 + milestone: *675 organization: *644 repository: *645 sender: *646 @@ -140041,7 +140439,7 @@ x-webhooks: - opened enterprise: *642 installation: *643 - milestone: *680 + milestone: *685 organization: *644 repository: *645 sender: *646 @@ -140122,7 +140520,7 @@ x-webhooks: type: string enum: - blocked - blocked_user: *665 + blocked_user: *670 enterprise: *642 installation: *643 organization: *644 @@ -140205,7 +140603,7 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *665 + blocked_user: *670 enterprise: *642 installation: *643 organization: *644 @@ -140290,7 +140688,7 @@ x-webhooks: - deleted enterprise: *642 installation: *643 - membership: &681 + membership: &686 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -140460,7 +140858,7 @@ x-webhooks: - member_added enterprise: *642 installation: *643 - membership: *681 + membership: *686 organization: *644 repository: *645 sender: *646 @@ -140659,7 +141057,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - user: *665 + user: *670 required: - action - invitation @@ -140739,7 +141137,7 @@ x-webhooks: - member_removed enterprise: *642 installation: *643 - membership: *681 + membership: *686 organization: *644 repository: *645 sender: *646 @@ -140830,7 +141228,7 @@ x-webhooks: type: string enterprise: *642 installation: *643 - membership: *681 + membership: *686 organization: *644 repository: *645 sender: *646 @@ -141403,7 +141801,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &682 + items: &687 title: Ruby Gems metadata type: object properties: @@ -141923,7 +142321,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *682 + items: *687 source_url: type: string format: uri @@ -142252,7 +142650,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &683 + personal_access_token_request: &688 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -142467,7 +142865,7 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *683 + personal_access_token_request: *688 enterprise: *642 organization: *644 sender: *646 @@ -142548,7 +142946,7 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *683 + personal_access_token_request: *688 enterprise: *642 organization: *644 sender: *646 @@ -142628,7 +143026,7 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *683 + personal_access_token_request: *688 organization: *644 enterprise: *642 sender: *646 @@ -142736,7 +143134,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *684 + last_response: *689 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -143017,7 +143415,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project_card: &685 + project_card: &690 title: Project Card type: object properties: @@ -143218,7 +143616,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project_card: *685 + project_card: *690 repository: *645 sender: *646 required: @@ -143427,8 +143825,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *678 - required: *679 + properties: *683 + required: *684 nullable: true sender: *646 required: @@ -143525,7 +143923,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project_card: *685 + project_card: *690 repository: *645 sender: *646 required: @@ -143893,7 +144291,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project: &687 + project: &692 title: Project type: object properties: @@ -144098,7 +144496,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project_column: &686 + project_column: &691 title: Project Column type: object properties: @@ -144219,15 +144617,15 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project_column: *686 + project_column: *691 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *678 - required: *679 + properties: *683 + required: *684 nullable: true sender: *646 required: @@ -144320,7 +144718,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project_column: *686 + project_column: *691 repository: *645 sender: *646 required: @@ -144404,7 +144802,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project_column: *686 + project_column: *691 repository: *645 sender: *646 required: @@ -144488,7 +144886,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project: *687 + project: *692 repository: *645 sender: *646 required: @@ -144572,15 +144970,15 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project: *687 + project: *692 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *678 - required: *679 + properties: *683 + required: *684 nullable: true sender: *646 required: @@ -144685,7 +145083,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project: *687 + project: *692 repository: *645 sender: *646 required: @@ -144768,7 +145166,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project: *687 + project: *692 repository: *645 sender: *646 required: @@ -144851,7 +145249,7 @@ x-webhooks: - closed installation: *643 organization: *644 - projects_v2: &688 + projects_v2: &693 title: Projects v2 Project description: A projects v2 project type: object @@ -144995,7 +145393,7 @@ x-webhooks: - created installation: *643 organization: *644 - projects_v2: *688 + projects_v2: *693 sender: *646 required: - action @@ -145077,7 +145475,7 @@ x-webhooks: - deleted installation: *643 organization: *644 - projects_v2: *688 + projects_v2: *693 sender: *646 required: - action @@ -145195,7 +145593,7 @@ x-webhooks: type: string installation: *643 organization: *644 - projects_v2: *688 + projects_v2: *693 sender: *646 required: - action @@ -145277,7 +145675,7 @@ x-webhooks: type: string enum: - archived - changes: &690 + changes: &695 type: object properties: archived_at: @@ -145293,7 +145691,7 @@ x-webhooks: format: date-time installation: *643 organization: *644 - projects_v2_item: &689 + projects_v2_item: &694 title: Projects v2 Item description: An item belonging to a project type: object @@ -145428,7 +145826,7 @@ x-webhooks: type: string installation: *643 organization: *644 - projects_v2_item: *689 + projects_v2_item: *694 sender: *646 required: - action @@ -145511,7 +145909,7 @@ x-webhooks: - created installation: *643 organization: *644 - projects_v2_item: *689 + projects_v2_item: *694 sender: *646 required: - action @@ -145593,7 +145991,7 @@ x-webhooks: - deleted installation: *643 organization: *644 - projects_v2_item: *689 + projects_v2_item: *694 sender: *646 required: - action @@ -145703,7 +146101,7 @@ x-webhooks: - body installation: *643 organization: *644 - projects_v2_item: *689 + projects_v2_item: *694 sender: *646 required: - action @@ -145799,7 +146197,7 @@ x-webhooks: nullable: true installation: *643 organization: *644 - projects_v2_item: *689 + projects_v2_item: *694 sender: *646 required: - action @@ -145881,10 +146279,10 @@ x-webhooks: type: string enum: - restored - changes: *690 + changes: *695 installation: *643 organization: *644 - projects_v2_item: *689 + projects_v2_item: *694 sender: *646 required: - action @@ -145967,7 +146365,7 @@ x-webhooks: - reopened installation: *643 organization: *644 - projects_v2: *688 + projects_v2: *693 sender: *646 required: - action @@ -146118,10 +146516,10 @@ x-webhooks: type: string enum: - assigned - assignee: *665 + assignee: *670 enterprise: *642 installation: *643 - number: &691 + number: &696 description: The pull request number. type: integer organization: *644 @@ -153143,9 +153541,9 @@ x-webhooks: - closed enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 - pull_request: &692 + pull_request: &697 allOf: - *507 - type: object @@ -153292,9 +153690,9 @@ x-webhooks: - converted_to_draft enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 - pull_request: *692 + pull_request: *697 repository: *645 sender: *646 required: @@ -153377,9 +153775,9 @@ x-webhooks: - demilestoned enterprise: *642 milestone: *489 - number: *691 + number: *696 organization: *644 - pull_request: &693 + pull_request: &698 title: Pull Request type: object properties: @@ -158072,9 +158470,9 @@ x-webhooks: - from enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 - pull_request: *692 + pull_request: *697 repository: *645 sender: *646 required: @@ -160483,8 +160881,8 @@ x-webhooks: - labeled enterprise: *642 installation: *643 - label: *664 - number: *691 + label: *669 + number: *696 organization: *644 pull_request: title: Pull Request @@ -162825,7 +163223,7 @@ x-webhooks: - locked enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 pull_request: title: Pull Request @@ -165163,9 +165561,9 @@ x-webhooks: - milestoned enterprise: *642 milestone: *489 - number: *691 + number: *696 organization: *644 - pull_request: *693 + pull_request: *698 repository: *645 sender: *646 required: @@ -165247,9 +165645,9 @@ x-webhooks: - opened enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 - pull_request: *692 + pull_request: *697 repository: *645 sender: *646 required: @@ -165333,9 +165731,9 @@ x-webhooks: - ready_for_review enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 - pull_request: *692 + pull_request: *697 repository: *645 sender: *646 required: @@ -165418,9 +165816,9 @@ x-webhooks: - reopened enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 - pull_request: *692 + pull_request: *697 repository: *645 sender: *646 required: @@ -168013,7 +168411,7 @@ x-webhooks: type: string enum: - deleted - comment: &695 + comment: &700 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -170512,8 +170910,8 @@ x-webhooks: type: string enum: - edited - changes: *694 - comment: *695 + changes: *699 + comment: *700 enterprise: *642 installation: *643 organization: *644 @@ -177159,7 +177557,7 @@ x-webhooks: - auto_merge - active_lock_reason repository: *645 - review: &696 + review: &701 description: The review that was affected. type: object properties: @@ -189124,7 +189522,7 @@ x-webhooks: - auto_merge - active_lock_reason repository: *645 - review: *696 + review: *701 sender: *646 required: - action @@ -194053,7 +194451,7 @@ x-webhooks: type: string enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 pull_request: title: Pull Request @@ -196382,10 +196780,10 @@ x-webhooks: type: string enum: - unassigned - assignee: *697 + assignee: *702 enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 pull_request: title: Pull Request @@ -198725,8 +199123,8 @@ x-webhooks: - unlabeled enterprise: *642 installation: *643 - label: *664 - number: *691 + label: *669 + number: *696 organization: *644 pull_request: title: Pull Request @@ -201058,7 +201456,7 @@ x-webhooks: - unlocked enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 pull_request: title: Pull Request @@ -204604,7 +205002,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *682 + items: *687 summary: type: string tag_name: @@ -205039,7 +205437,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *682 + items: *687 summary: type: string tag_name: @@ -205168,7 +205566,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - release: &698 + release: &703 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -205551,7 +205949,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - release: *698 + release: *703 repository: *645 sender: *646 required: @@ -205663,7 +206061,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - release: *698 + release: *703 repository: *645 sender: *646 required: @@ -206130,7 +206528,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - release: &699 + release: &704 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -206513,7 +206911,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - release: *698 + release: *703 repository: *645 sender: *646 required: @@ -206593,7 +206991,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - release: *699 + release: *704 repository: *645 sender: *646 required: @@ -208242,7 +208640,7 @@ x-webhooks: type: string enum: - create - alert: &700 + alert: &705 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -208649,7 +209047,7 @@ x-webhooks: type: string enum: - reopen - alert: *700 + alert: *705 enterprise: *642 installation: *643 organization: *644 @@ -208932,7 +209330,7 @@ x-webhooks: type: string enum: - created - alert: &701 + alert: &706 type: object properties: number: *71 @@ -209096,9 +209494,9 @@ x-webhooks: type: string enum: - created - alert: *701 + alert: *706 installation: *643 - location: *702 + location: *707 organization: *644 repository: *645 sender: *646 @@ -209336,7 +209734,7 @@ x-webhooks: type: string enum: - reopened - alert: *701 + alert: *706 enterprise: *642 installation: *643 organization: *644 @@ -209418,7 +209816,7 @@ x-webhooks: type: string enum: - resolved - alert: *701 + alert: *706 enterprise: *642 installation: *643 organization: *644 @@ -209500,7 +209898,7 @@ x-webhooks: type: string enum: - validated - alert: *701 + alert: *706 enterprise: *642 installation: *643 organization: *644 @@ -209584,7 +209982,7 @@ x-webhooks: installation: *643 organization: *644 repository: *645 - security_advisory: &703 + security_advisory: &708 description: The details of the security advisory, including summary, description, and severity. type: object @@ -209770,7 +210168,7 @@ x-webhooks: installation: *643 organization: *644 repository: *645 - security_advisory: *703 + security_advisory: *708 sender: *646 required: - action @@ -210116,7 +210514,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - sponsorship: &704 + sponsorship: &709 type: object properties: created_at: @@ -210416,7 +210814,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - sponsorship: *704 + sponsorship: *709 required: - action - sponsorship @@ -210509,7 +210907,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - sponsorship: *704 + sponsorship: *709 required: - action - changes @@ -210586,7 +210984,7 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &705 + effective_date: &710 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. @@ -210596,7 +210994,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - sponsorship: *704 + sponsorship: *709 required: - action - sponsorship @@ -210670,7 +211068,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &706 + changes: &711 type: object properties: tier: @@ -210714,13 +211112,13 @@ x-webhooks: - from required: - tier - effective_date: *705 + effective_date: *710 enterprise: *642 installation: *643 organization: *644 repository: *645 sender: *646 - sponsorship: *704 + sponsorship: *709 required: - action - changes @@ -210797,13 +211195,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *706 + changes: *711 enterprise: *642 installation: *643 organization: *644 repository: *645 sender: *646 - sponsorship: *704 + sponsorship: *709 required: - action - changes @@ -211497,7 +211895,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - team: &707 + team: &712 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -212144,7 +212542,7 @@ x-webhooks: - topics - visibility sender: *646 - team: *707 + team: *712 required: - action - team @@ -212677,7 +213075,7 @@ x-webhooks: - topics - visibility sender: *646 - team: *707 + team: *712 required: - action - team @@ -213211,7 +213609,7 @@ x-webhooks: - topics - visibility sender: *646 - team: *707 + team: *712 required: - action - team @@ -213812,7 +214210,7 @@ x-webhooks: - topics - visibility sender: *646 - team: *707 + team: *712 required: - action - changes @@ -214347,7 +214745,7 @@ x-webhooks: - topics - visibility sender: *646 - team: *707 + team: *712 required: - action - team @@ -215692,7 +216090,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - workflow: *660 + workflow: *665 workflow_run: title: Workflow Run type: object @@ -216687,7 +217085,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - workflow: *660 + workflow: *665 workflow_run: title: Workflow Run type: object @@ -217676,7 +218074,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - workflow: *660 + workflow: *665 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index 9b4491620..c6af04da9 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -73114,7 +73114,7 @@ "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand code matching policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can configure and view details about the organization's Copilot Business subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -73368,7 +73368,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).\n\nOnly organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription.\nOnly organization owners can view assigned seats.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -73883,8 +73883,88 @@ } ] }, + "organization": { + "type": "object", + "description": "The organization to which this seat belongs.", + "nullable": true, + "oneOf": [ + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ] + }, "assigning_team": { - "description": "The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually.", + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", "oneOf": [ { "title": "Team", @@ -74057,6 +74137,62 @@ "slug", "parent" ] + }, + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "example": "disabled | all" + }, + "group_id": { + "nullable": true, + "type": "integer", + "example": 1 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/dc/teams/justice-league" + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "sync_to_organizations", + "name", + "html_url", + "slug", + "created_at", + "updated_at" + ] } ], "nullable": true @@ -74303,7 +74439,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -74501,7 +74637,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -74701,7 +74837,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -74899,7 +75035,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -97846,7 +97982,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOrganization owners can view GitHub Copilot seat assignment details for members in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -98343,8 +98479,88 @@ } ] }, + "organization": { + "type": "object", + "description": "The organization to which this seat belongs.", + "nullable": true, + "oneOf": [ + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ] + }, "assigning_team": { - "description": "The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually.", + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", "oneOf": [ { "title": "Team", @@ -98517,6 +98733,62 @@ "slug", "parent" ] + }, + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "example": "disabled | all" + }, + "group_id": { + "nullable": true, + "type": "integer", + "example": 1 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/dc/teams/justice-league" + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "sync_to_organizations", + "name", + "html_url", + "slug", + "created_at", + "updated_at" + ] } ], "nullable": true @@ -99115,7 +99387,7 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], @@ -115213,7 +115485,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -115404,7 +115678,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -115519,7 +115795,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -115716,7 +115994,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -115891,7 +116171,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -115970,7 +116252,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -231559,7 +231843,7 @@ }, { "name": "since", - "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -231569,7 +231853,7 @@ }, { "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -519654,7 +519938,8790 @@ }, "required": [ "action", - "repository", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_configuration", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "branch-protection-configuration-enabled": { + "post": { + "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "description": "All branch protections were enabled for a repository.", + "operationId": "branch-protection-configuration/enabled", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_configuration" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "branch protection configuration enabled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "enabled" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_configuration", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "branch-protection-rule-created": { + "post": { + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "description": "A branch protection rule was created.", + "operationId": "branch-protection-rule/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "branch protection rule created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "rule": { + "title": "branch protection rule", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "type": "object", + "properties": { + "admin_enforced": { + "type": "boolean" + }, + "allow_deletions_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "allow_force_pushes_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "authorized_actor_names": { + "type": "array", + "items": { + "type": "string" + } + }, + "authorized_actors_only": { + "type": "boolean" + }, + "authorized_dismissal_actors_only": { + "type": "boolean" + }, + "create_protected": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "ignore_approvals_from_contributors": { + "type": "boolean" + }, + "linear_history_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "merge_queue_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "name": { + "type": "string" + }, + "pull_request_reviews_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "repository_id": { + "type": "integer" + }, + "require_code_owner_review": { + "type": "boolean" + }, + "require_last_push_approval": { + "description": "Whether the most recent push must be approved by someone other than the person who pushed it", + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "required_conversation_resolution_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_deployments_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_status_checks": { + "type": "array", + "items": { + "type": "string" + } + }, + "required_status_checks_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "signature_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "strict_required_status_checks_policy": { + "type": "boolean" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "repository_id", + "name", + "created_at", + "updated_at", + "pull_request_reviews_enforcement_level", + "required_approving_review_count", + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "authorized_dismissal_actors_only", + "ignore_approvals_from_contributors", + "required_status_checks", + "required_status_checks_enforcement_level", + "strict_required_status_checks_policy", + "signature_requirement_enforcement_level", + "linear_history_requirement_enforcement_level", + "admin_enforced", + "allow_force_pushes_enforcement_level", + "allow_deletions_enforcement_level", + "merge_queue_enforcement_level", + "required_deployments_enforcement_level", + "required_conversation_resolution_level", + "authorized_actors_only", + "authorized_actor_names" + ] + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "rule", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_rule", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "branch-protection-rule-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "description": "A branch protection rule was deleted.", + "operationId": "branch-protection-rule/deleted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "branch protection rule deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "rule": { + "title": "branch protection rule", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "type": "object", + "properties": { + "admin_enforced": { + "type": "boolean" + }, + "allow_deletions_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "allow_force_pushes_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "authorized_actor_names": { + "type": "array", + "items": { + "type": "string" + } + }, + "authorized_actors_only": { + "type": "boolean" + }, + "authorized_dismissal_actors_only": { + "type": "boolean" + }, + "create_protected": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "ignore_approvals_from_contributors": { + "type": "boolean" + }, + "linear_history_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "merge_queue_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "name": { + "type": "string" + }, + "pull_request_reviews_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "repository_id": { + "type": "integer" + }, + "require_code_owner_review": { + "type": "boolean" + }, + "require_last_push_approval": { + "description": "Whether the most recent push must be approved by someone other than the person who pushed it", + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "required_conversation_resolution_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_deployments_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_status_checks": { + "type": "array", + "items": { + "type": "string" + } + }, + "required_status_checks_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "signature_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "strict_required_status_checks_policy": { + "type": "boolean" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "repository_id", + "name", + "created_at", + "updated_at", + "pull_request_reviews_enforcement_level", + "required_approving_review_count", + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "authorized_dismissal_actors_only", + "ignore_approvals_from_contributors", + "required_status_checks", + "required_status_checks_enforcement_level", + "strict_required_status_checks_policy", + "signature_requirement_enforcement_level", + "linear_history_requirement_enforcement_level", + "admin_enforced", + "allow_force_pushes_enforcement_level", + "allow_deletions_enforcement_level", + "merge_queue_enforcement_level", + "required_deployments_enforcement_level", + "required_conversation_resolution_level", + "authorized_actors_only", + "authorized_actor_names" + ] + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "rule", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_rule", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "branch-protection-rule-edited": { + "post": { + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "description": "A branch protection rule was edited.", + "operationId": "branch-protection-rule/edited", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "branch protection rule edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "description": "If the action was `edited`, the changes to the rule.", + "type": "object", + "properties": { + "admin_enforced": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "authorized_actor_names": { + "type": "object", + "properties": { + "from": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "from" + ] + }, + "authorized_actors_only": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "authorized_dismissal_actors_only": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "linear_history_requirement_enforcement_level": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + } + }, + "required": [ + "from" + ] + }, + "required_status_checks": { + "type": "object", + "properties": { + "from": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "from" + ] + }, + "required_status_checks_enforcement_level": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + } + }, + "required": [ + "from" + ] + } + } + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "rule": { + "title": "branch protection rule", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "type": "object", + "properties": { + "admin_enforced": { + "type": "boolean" + }, + "allow_deletions_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "allow_force_pushes_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "authorized_actor_names": { + "type": "array", + "items": { + "type": "string" + } + }, + "authorized_actors_only": { + "type": "boolean" + }, + "authorized_dismissal_actors_only": { + "type": "boolean" + }, + "create_protected": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "ignore_approvals_from_contributors": { + "type": "boolean" + }, + "linear_history_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "merge_queue_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "name": { + "type": "string" + }, + "pull_request_reviews_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "repository_id": { + "type": "integer" + }, + "require_code_owner_review": { + "type": "boolean" + }, + "require_last_push_approval": { + "description": "Whether the most recent push must be approved by someone other than the person who pushed it", + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "required_conversation_resolution_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_deployments_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_status_checks": { + "type": "array", + "items": { + "type": "string" + } + }, + "required_status_checks_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "signature_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "strict_required_status_checks_policy": { + "type": "boolean" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "repository_id", + "name", + "created_at", + "updated_at", + "pull_request_reviews_enforcement_level", + "required_approving_review_count", + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "authorized_dismissal_actors_only", + "ignore_approvals_from_contributors", + "required_status_checks", + "required_status_checks_enforcement_level", + "strict_required_status_checks_policy", + "signature_requirement_enforcement_level", + "linear_history_requirement_enforcement_level", + "admin_enforced", + "allow_force_pushes_enforcement_level", + "allow_deletions_enforcement_level", + "merge_queue_enforcement_level", + "required_deployments_enforcement_level", + "required_conversation_resolution_level", + "authorized_actors_only", + "authorized_actor_names" + ] + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "rule", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_rule", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-push-ruleset-cancelled": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A push ruleset bypass request was cancelled.", + "operationId": "exemption-request-push-ruleset/cancelled", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Exemption request cancellation event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "cancelled" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "example": "827efc6d56897b048c772eb4087f854f46256132" + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": "string", + "description": "The comment the requester provided when creating the exemption request.", + "nullable": true + }, + "metadata": { + "type": "object", + "description": "Metadata about the exemption request.", + "nullable": true, + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": "array", + "description": "The responses to the exemption request.", + "nullable": true, + "items": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "example": "https://github.com/monalisa/smile/exemptions/1" + } + } + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "exemption_request", "sender" ] } @@ -519669,7 +528736,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "branch_protection_configuration", + "subcategory": "bypass_request_push_ruleset", "supported-webhook-types": [ "repository", "organization", @@ -519678,13 +528745,13 @@ } } }, - "branch-protection-configuration-enabled": { + "bypass-request-push-ruleset-completed": { "post": { - "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "All branch protections were enabled for a repository.", - "operationId": "branch-protection-configuration/enabled", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A push ruleset bypass request was completed.", + "operationId": "exemption-request-push-ruleset/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_configuration" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" }, "parameters": [ { @@ -519749,13 +528816,13 @@ "content": { "application/json": { "schema": { - "title": "branch protection configuration enabled event", + "title": "Exemption request completed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "enabled" + "completed" ] }, "enterprise": { @@ -521126,6 +530193,219 @@ "updated_at" ] }, + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "example": "827efc6d56897b048c772eb4087f854f46256132" + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": "string", + "description": "The comment the requester provided when creating the exemption request.", + "nullable": true + }, + "metadata": { + "type": "object", + "description": "Metadata about the exemption request.", + "nullable": true, + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": "array", + "description": "The responses to the exemption request.", + "nullable": true, + "items": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "example": "https://github.com/monalisa/smile/exemptions/1" + } + } + }, "sender": { "title": "Simple User", "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", @@ -521248,7 +530528,7 @@ }, "required": [ "action", - "repository", + "exemption_request", "sender" ] } @@ -521263,7 +530543,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "branch_protection_configuration", + "subcategory": "bypass_request_push_ruleset", "supported-webhook-types": [ "repository", "organization", @@ -521272,13 +530552,13 @@ } } }, - "branch-protection-rule-created": { + "bypass-request-push-ruleset-created": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A branch protection rule was created.", - "operationId": "branch-protection-rule/created", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A push ruleset bypass request was created.", + "operationId": "exemption-request-push-ruleset/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" }, "parameters": [ { @@ -521343,7 +530623,7 @@ "content": { "application/json": { "schema": { - "title": "branch protection rule created event", + "title": "Exemption request created event", "type": "object", "properties": { "action": { @@ -522720,170 +532000,218 @@ "updated_at" ] }, - "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", "type": "object", "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } + "id": { + "type": "integer", + "description": "The ID of the exemption request." }, - "authorized_actors_only": { - "type": "boolean" + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." }, - "authorized_dismissal_actors_only": { - "type": "boolean" + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." }, - "create_protected": { - "type": "boolean" + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." }, - "created_at": { + "requester_login": { "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" + "description": "The login of the user who requested the exemption." }, - "linear_history_requirement_enforcement_level": { + "request_type": { "type": "string", + "description": "The type of request.", "enum": [ - "off", - "non_admins", - "everyone" + "push_ruleset_bypass", + "secret_scanning" ] }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } ] }, - "name": { - "type": "string" + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "example": "827efc6d56897b048c772eb4087f854f46256132" }, - "pull_request_reviews_enforcement_level": { + "status": { "type": "string", + "description": "The status of the exemption request.", "enum": [ - "off", - "non_admins", - "everyone" + "pending", + "rejected", + "cancelled", + "completed" ] }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" + "requester_comment": { + "type": "string", + "description": "The comment the requester provided when creating the exemption request.", + "nullable": true }, - "required_approving_review_count": { - "type": "integer" + "metadata": { + "type": "object", + "description": "Metadata about the exemption request.", + "nullable": true, + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] }, - "required_conversation_resolution_level": { + "expires_at": { "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] + "format": "date-time", + "description": "The date and time the exemption request will expire." }, - "required_deployments_enforcement_level": { + "created_at": { "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] + "format": "date-time", + "description": "The date and time the exemption request was created." }, - "required_status_checks": { + "responses": { "type": "array", + "description": "The responses to the exemption request.", + "nullable": true, "items": { - "type": "string" + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } } }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time" + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "example": "https://github.com/monalisa/smile/exemptions/1" } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + } }, "sender": { "title": "Simple User", @@ -523007,8 +532335,7 @@ }, "required": [ "action", - "rule", - "repository", + "exemption_request", "sender" ] } @@ -523023,7 +532350,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "branch_protection_rule", + "subcategory": "bypass_request_push_ruleset", "supported-webhook-types": [ "repository", "organization", @@ -523032,13 +532359,13 @@ } } }, - "branch-protection-rule-deleted": { + "bypass-request-push-ruleset-response-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A branch protection rule was deleted.", - "operationId": "branch-protection-rule/deleted", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A push ruleset bypass response was dismissed.", + "operationId": "exemption-request-push-ruleset/response-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" }, "parameters": [ { @@ -523103,13 +532430,13 @@ "content": { "application/json": { "schema": { - "title": "branch protection rule deleted event", + "title": "Exemption response dismissed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "response_dismissed" ] }, "enterprise": { @@ -524480,170 +533807,251 @@ "updated_at" ] }, - "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", "type": "object", "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } + "id": { + "type": "integer", + "description": "The ID of the exemption request." }, - "authorized_actors_only": { - "type": "boolean" + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." }, - "authorized_dismissal_actors_only": { - "type": "boolean" + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." }, - "create_protected": { - "type": "boolean" + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." }, - "created_at": { + "requester_login": { "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" + "description": "The login of the user who requested the exemption." }, - "linear_history_requirement_enforcement_level": { + "request_type": { "type": "string", + "description": "The type of request.", "enum": [ - "off", - "non_admins", - "everyone" + "push_ruleset_bypass", + "secret_scanning" ] }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } ] }, - "name": { - "type": "string" + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "example": "827efc6d56897b048c772eb4087f854f46256132" }, - "pull_request_reviews_enforcement_level": { + "status": { "type": "string", + "description": "The status of the exemption request.", "enum": [ - "off", - "non_admins", - "everyone" + "pending", + "rejected", + "cancelled", + "completed" ] }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" + "requester_comment": { + "type": "string", + "description": "The comment the requester provided when creating the exemption request.", + "nullable": true }, - "required_approving_review_count": { - "type": "integer" + "metadata": { + "type": "object", + "description": "Metadata about the exemption request.", + "nullable": true, + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] }, - "required_conversation_resolution_level": { + "expires_at": { "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] + "format": "date-time", + "description": "The date and time the exemption request will expire." }, - "required_deployments_enforcement_level": { + "created_at": { "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] + "format": "date-time", + "description": "The date and time the exemption request was created." }, - "required_status_checks": { + "responses": { "type": "array", + "description": "The responses to the exemption request.", + "nullable": true, "items": { - "type": "string" + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } } }, - "required_status_checks_enforcement_level": { + "html_url": { "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "example": "https://github.com/monalisa/smile/exemptions/1" + } + } + }, + "exemption_response": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." }, - "signature_requirement_enforcement_level": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { "type": "string", + "description": "The status of the exemption response.", "enum": [ - "off", - "non_admins", - "everyone" + "approved", + "rejected", + "dismissed" ] }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { + "created_at": { "type": "string", - "format": "date-time" + "format": "date-time", + "description": "The date and time the exemption request was created." } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + } }, "sender": { "title": "Simple User", @@ -524767,8 +534175,8 @@ }, "required": [ "action", - "rule", - "repository", + "exemption_request", + "exemption_response", "sender" ] } @@ -524783,7 +534191,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "branch_protection_rule", + "subcategory": "bypass_request_push_ruleset", "supported-webhook-types": [ "repository", "organization", @@ -524792,13 +534200,13 @@ } } }, - "branch-protection-rule-edited": { + "bypass-request-push-ruleset-response-submitted": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A branch protection rule was edited.", - "operationId": "branch-protection-rule/edited", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A response either approving or rejecting the push ruleset bypass request was submitted.", + "operationId": "exemption-request-push-ruleset/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" }, "parameters": [ { @@ -524863,117 +534271,15 @@ "content": { "application/json": { "schema": { - "title": "branch protection rule edited event", + "title": "Exemption response submitted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "response_submitted" ] }, - "changes": { - "description": "If the action was `edited`, the changes to the rule.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "object", - "properties": { - "from": { - "type": "boolean", - "nullable": true - } - }, - "required": [ - "from" - ] - }, - "authorized_actor_names": { - "type": "object", - "properties": { - "from": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "from" - ] - }, - "authorized_actors_only": { - "type": "object", - "properties": { - "from": { - "type": "boolean", - "nullable": true - } - }, - "required": [ - "from" - ] - }, - "authorized_dismissal_actors_only": { - "type": "object", - "properties": { - "from": { - "type": "boolean", - "nullable": true - } - }, - "required": [ - "from" - ] - }, - "linear_history_requirement_enforcement_level": { - "type": "object", - "properties": { - "from": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - } - }, - "required": [ - "from" - ] - }, - "required_status_checks": { - "type": "object", - "properties": { - "from": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "from" - ] - }, - "required_status_checks_enforcement_level": { - "type": "object", - "properties": { - "from": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - } - }, - "required": [ - "from" - ] - } - } - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", @@ -526342,170 +535648,251 @@ "updated_at" ] }, - "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", "type": "object", "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } + "id": { + "type": "integer", + "description": "The ID of the exemption request." }, - "authorized_actors_only": { - "type": "boolean" + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." }, - "authorized_dismissal_actors_only": { - "type": "boolean" + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." }, - "create_protected": { - "type": "boolean" + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." }, - "created_at": { + "requester_login": { "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" + "description": "The login of the user who requested the exemption." }, - "linear_history_requirement_enforcement_level": { + "request_type": { "type": "string", + "description": "The type of request.", "enum": [ - "off", - "non_admins", - "everyone" + "push_ruleset_bypass", + "secret_scanning" ] }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } ] }, - "name": { - "type": "string" + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "example": "827efc6d56897b048c772eb4087f854f46256132" }, - "pull_request_reviews_enforcement_level": { + "status": { "type": "string", + "description": "The status of the exemption request.", "enum": [ - "off", - "non_admins", - "everyone" + "pending", + "rejected", + "cancelled", + "completed" ] }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" + "requester_comment": { + "type": "string", + "description": "The comment the requester provided when creating the exemption request.", + "nullable": true }, - "required_approving_review_count": { - "type": "integer" + "metadata": { + "type": "object", + "description": "Metadata about the exemption request.", + "nullable": true, + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] }, - "required_conversation_resolution_level": { + "expires_at": { "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] + "format": "date-time", + "description": "The date and time the exemption request will expire." }, - "required_deployments_enforcement_level": { + "created_at": { "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] + "format": "date-time", + "description": "The date and time the exemption request was created." }, - "required_status_checks": { + "responses": { "type": "array", + "description": "The responses to the exemption request.", + "nullable": true, "items": { - "type": "string" + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } } }, - "required_status_checks_enforcement_level": { + "html_url": { "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "example": "https://github.com/monalisa/smile/exemptions/1" + } + } + }, + "exemption_response": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." }, - "signature_requirement_enforcement_level": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", "enum": [ - "off", - "non_admins", - "everyone" + "approved", + "rejected", + "dismissed" ] }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { + "created_at": { "type": "string", - "format": "date-time" + "format": "date-time", + "description": "The date and time the exemption request was created." } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + } }, "sender": { "title": "Simple User", @@ -526629,8 +536016,8 @@ }, "required": [ "action", - "rule", - "repository", + "exemption_request", + "exemption_response", "sender" ] } @@ -526645,7 +536032,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "branch_protection_rule", + "subcategory": "bypass_request_push_ruleset", "supported-webhook-types": [ "repository", "organization", @@ -572380,7 +581767,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -573234,7 +582623,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 52d78c037..b14080501 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -23535,12 +23535,12 @@ paths: **Note**: This endpoint is in beta and is subject to change. Gets information about an organization's Copilot subscription, including seat breakdown - and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. + and feature policies. To configure these settings, go to your organization's settings on GitHub.com. For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". - Only organization owners can configure and view details about the organization's Copilot Business subscription. + Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/get-copilot-organization-details @@ -23663,11 +23663,10 @@ paths: description: |- **Note**: This endpoint is in beta and is subject to change. - Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + Only organization owners can view assigned seats. - Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. - - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/list-copilot-seats @@ -23974,12 +23973,59 @@ paths: - type - created_at - updated_at + organization: + type: object + description: The organization to which this seat belongs. + nullable: true + oneOf: + - *52 assigning_team: - description: The team that granted access to GitHub Copilot - to the assignee. This will be null if the user was assigned - a seat individually. + description: The team through which the assignee is granted + access to GitHub Copilot, if applicable. oneOf: - *163 + - title: Enterprise Team + description: Group of enterprise owners and/or members + type: object + properties: + id: + type: integer + name: + type: string + slug: + type: string + url: + type: string + format: uri + sync_to_organizations: + type: string + example: disabled | all + group_id: + nullable: true + type: integer + example: 1 + html_url: + type: string + format: uri + example: https://github.com/enterprises/dc/teams/justice-league + members_url: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - url + - members_url + - sync_to_organizations + - name + - html_url + - slug + - created_at + - updated_at nullable: true pending_cancellation_date: type: string @@ -24102,13 +24148,13 @@ paths: Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-teams @@ -24183,9 +24229,9 @@ paths: For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can cancel Copilot seats for their organization members. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-teams @@ -24257,13 +24303,13 @@ paths: Purchases a GitHub Copilot seat for each user specified. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-users @@ -24338,9 +24384,9 @@ paths: For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can cancel Copilot seats for their organization members. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-users @@ -27890,9 +27936,9 @@ paths: Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. - Organization owners can view GitHub Copilot seat assignment details for members in their organization. + Only organization owners can view Copilot seat assignment details for members of their organization. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/get-copilot-seat-details-for-user @@ -28090,10 +28136,10 @@ paths: the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email - will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user - is limited to 50 organization invitations per 24 hour period. If the organization - is more than one month old or on a paid plan, the limit is 500 invitations - per 24 hour period." + will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners + are limited to creating 50 organization invitations for an organization within + a 24 hour period. If the organization is more than one month old or on a paid + plan, the limit is 500 invitations per 24 hour period." tags: - orgs operationId: orgs/set-membership-for-user @@ -31435,6 +31481,8 @@ paths: enum: - string - single_select + - multi_select + - true_false description: The type of the value for the property required: type: boolean @@ -31637,6 +31685,8 @@ paths: enum: - string - single_select + - multi_select + - true_false description: The type of the value for the property required: type: boolean @@ -50685,7 +50735,7 @@ paths: check. type: array items: *351 - deployment: &650 + deployment: &655 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -51595,7 +51645,7 @@ paths: type: string format: date-time nullable: true - head_commit: &676 + head_commit: &681 title: Simple Commit description: A commit. type: object @@ -56912,10 +56962,22 @@ paths: required: false schema: type: string - - *90 + - name: since + description: 'Only show results that were last updated after the given time. + This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must + be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may + be returned.' + in: query + required: false + schema: + type: string + format: date-time - name: until description: 'Only commits before this date will be returned. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 + (inclusive) or unexpected results may be returned.' in: query required: false schema: @@ -65833,7 +65895,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &684 + last_response: &689 title: Hook Response type: object properties: @@ -81763,7 +81825,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &702 + items: &707 type: object properties: type: @@ -99718,7 +99780,7 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &678 + properties: &683 id: description: Unique identifier of the repository example: 42 @@ -100400,7 +100462,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &679 + required: &684 - archive_url - assignees_url - blobs_url @@ -101107,20 +101169,20 @@ x-webhooks: - repository - organization - app - bypass-request-secret-scanning-cancelled: + bypass-request-push-ruleset-cancelled: post: summary: |- - This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + This event occurs when there is activity related to a user's request to bypass a set of push rules. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - Note: Delegated bypass for push protection is currently in beta and subject to change. - description: A secret scanning push protection bypass request was cancelled. - operationId: exemption-request-secret-scanning/cancelled + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A push ruleset bypass request was cancelled. + operationId: exemption-request-push-ruleset/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset parameters: - name: User-Agent in: header @@ -101161,7 +101223,7 @@ x-webhooks: required: true content: application/json: - schema: + schema: &650 title: Exemption request cancellation event type: object properties: @@ -101355,25 +101417,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: bypass_request_secret_scanning + subcategory: bypass_request_push_ruleset supported-webhook-types: - repository - organization - app - bypass-request-secret-scanning-completed: + bypass-request-push-ruleset-completed: post: summary: |- - This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + This event occurs when there is activity related to a user's request to bypass a set of push rules. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - Note: Delegated bypass for push protection is currently in beta and subject to change. - description: A secret scanning bypass request was completed. - operationId: exemption-request-secret-scanning/completed + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A push ruleset bypass request was completed. + operationId: exemption-request-push-ruleset/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset parameters: - name: User-Agent in: header @@ -101414,7 +101476,7 @@ x-webhooks: required: true content: application/json: - schema: + schema: &651 title: Exemption request completed event type: object properties: @@ -101439,25 +101501,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: bypass_request_secret_scanning + subcategory: bypass_request_push_ruleset supported-webhook-types: - repository - organization - app - bypass-request-secret-scanning-created: + bypass-request-push-ruleset-created: post: summary: |- - This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + This event occurs when there is activity related to a user's request to bypass a set of push rules. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - Note: Delegated bypass for push protection is currently in beta and subject to change. - description: A secret scanning push protection bypass request was created. - operationId: exemption-request-secret-scanning/created + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A push ruleset bypass request was created. + operationId: exemption-request-push-ruleset/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset parameters: - name: User-Agent in: header @@ -101498,7 +101560,7 @@ x-webhooks: required: true content: application/json: - schema: + schema: &652 title: Exemption request created event type: object properties: @@ -101523,25 +101585,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: bypass_request_secret_scanning + subcategory: bypass_request_push_ruleset supported-webhook-types: - repository - organization - app - bypass-request-secret-scanning-response-dismissed: + bypass-request-push-ruleset-response-dismissed: post: summary: |- - This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + This event occurs when there is activity related to a user's request to bypass a set of push rules. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - Note: Delegated bypass for push protection is currently in beta and subject to change. - description: A secret scanning push protection bypass response was dismissed. - operationId: exemption-request-secret-scanning/response-dismissed + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A push ruleset bypass response was dismissed. + operationId: exemption-request-push-ruleset/response-dismissed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset parameters: - name: User-Agent in: header @@ -101582,7 +101644,7 @@ x-webhooks: required: true content: application/json: - schema: + schema: &653 title: Exemption response dismissed event type: object properties: @@ -101609,26 +101671,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: bypass_request_secret_scanning + subcategory: bypass_request_push_ruleset supported-webhook-types: - repository - organization - app - bypass-request-secret-scanning-response-submitted: + bypass-request-push-ruleset-response-submitted: post: summary: |- - This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + This event occurs when there is activity related to a user's request to bypass a set of push rules. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - Note: Delegated bypass for push protection is currently in beta and subject to change. - description: A response either approving or rejecting the secret scanning push - protection bypass request was submitted. - operationId: exemption-request-secret-scanning/response-submitted + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A response either approving or rejecting the push ruleset bypass + request was submitted. + operationId: exemption-request-push-ruleset/response-submitted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset parameters: - name: User-Agent in: header @@ -101669,7 +101731,7 @@ x-webhooks: required: true content: application/json: - schema: + schema: &654 title: Exemption response submitted event type: object properties: @@ -101693,6 +101755,342 @@ x-webhooks: '200': description: Return a 200 status to indicate that the data was received successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_push_ruleset + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-cancelled: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning push protection bypass request was cancelled. + operationId: exemption-request-secret-scanning/cancelled + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: *650 + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-completed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning bypass request was completed. + operationId: exemption-request-secret-scanning/completed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: *651 + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-created: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning push protection bypass request was created. + operationId: exemption-request-secret-scanning/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: *652 + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-response-dismissed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning push protection bypass response was dismissed. + operationId: exemption-request-secret-scanning/response-dismissed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: *653 + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-response-submitted: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A response either approving or rejecting the secret scanning push + protection bypass request was submitted. + operationId: exemption-request-secret-scanning/response-submitted + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: *654 + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully x-github: githubCloudOnly: false category: webhooks @@ -101765,7 +102163,7 @@ x-webhooks: type: string enum: - completed - check_run: &651 + check_run: &656 title: CheckRun description: A check performed on the code of a given code change type: object @@ -101866,7 +102264,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *650 + deployment: *655 details_url: example: https://example.com type: string @@ -102345,7 +102743,7 @@ x-webhooks: type: string enum: - created - check_run: *651 + check_run: *656 installation: *643 organization: *644 repository: *645 @@ -102743,7 +103141,7 @@ x-webhooks: type: string enum: - requested_action - check_run: *651 + check_run: *656 installation: *643 organization: *644 repository: *645 @@ -103150,7 +103548,7 @@ x-webhooks: type: string enum: - rerequested - check_run: *651 + check_run: *656 installation: *643 organization: *644 repository: *645 @@ -105750,7 +106148,7 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &652 + commit_oid: &657 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. @@ -105758,7 +106156,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - ref: &653 + ref: &658 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. @@ -106079,11 +106477,11 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *652 + commit_oid: *657 enterprise: *642 installation: *643 organization: *644 - ref: *653 + ref: *658 repository: *645 sender: *646 required: @@ -106340,11 +106738,11 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *652 + commit_oid: *657 enterprise: *642 installation: *643 organization: *644 - ref: *653 + ref: *658 repository: *645 sender: *646 required: @@ -106664,11 +107062,11 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *652 + commit_oid: *657 enterprise: *642 installation: *643 organization: *644 - ref: *653 + ref: *658 repository: *645 sender: *646 required: @@ -107161,11 +107559,11 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *652 + commit_oid: *657 enterprise: *642 installation: *643 organization: *644 - ref: *653 + ref: *658 repository: *645 sender: *646 required: @@ -107510,11 +107908,11 @@ x-webhooks: `main`). type: string organization: *644 - pusher_type: &654 + pusher_type: &659 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &655 + ref: &660 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -107943,8 +108341,8 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - pusher_type: *654 - ref: *655 + pusher_type: *659 + ref: *660 ref_type: description: The type of Git ref object deleted in the repository. type: string @@ -108632,7 +109030,7 @@ x-webhooks: - created enterprise: *642 installation: *643 - key: &656 + key: &661 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -108746,7 +109144,7 @@ x-webhooks: - deleted enterprise: *642 installation: *643 - key: *656 + key: *661 organization: *644 repository: *645 sender: *646 @@ -109310,7 +109708,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - workflow: &660 + workflow: &665 title: Workflow type: object nullable: true @@ -110109,7 +110507,7 @@ x-webhooks: type: string enum: - approved - approver: &657 + approver: &662 type: object properties: avatar_url: @@ -110154,7 +110552,7 @@ x-webhooks: installation: *643 organization: *644 repository: *645 - reviewers: &658 + reviewers: &663 type: array items: type: object @@ -110233,7 +110631,7 @@ x-webhooks: sender: *646 since: type: string - workflow_job_run: &659 + workflow_job_run: &664 type: object properties: conclusion: @@ -110956,18 +111354,18 @@ x-webhooks: type: string enum: - rejected - approver: *657 + approver: *662 comment: type: string enterprise: *642 installation: *643 organization: *644 repository: *645 - reviewers: *658 + reviewers: *663 sender: *646 since: type: string - workflow_job_run: *659 + workflow_job_run: *664 workflow_job_runs: type: array items: @@ -111669,7 +112067,7 @@ x-webhooks: installation: *643 organization: *644 repository: *645 - requestor: &665 + requestor: &670 title: User type: object nullable: true @@ -113549,7 +113947,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - workflow: *660 + workflow: *665 workflow_run: title: Deployment Workflow Run type: object @@ -114224,7 +114622,7 @@ x-webhooks: type: string enum: - answered - answer: &663 + answer: &668 type: object properties: author_association: @@ -114378,7 +114776,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &661 + discussion: &666 title: Discussion description: A Discussion in a repository. type: object @@ -114807,7 +115205,7 @@ x-webhooks: - from required: - category - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -114893,7 +115291,7 @@ x-webhooks: type: string enum: - closed - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -114978,7 +115376,7 @@ x-webhooks: type: string enum: - created - comment: &662 + comment: &667 type: object properties: author_association: @@ -115132,7 +115530,7 @@ x-webhooks: - updated_at - body - reactions - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -115218,8 +115616,8 @@ x-webhooks: type: string enum: - deleted - comment: *662 - discussion: *661 + comment: *667 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -115317,8 +115715,8 @@ x-webhooks: - from required: - body - comment: *662 - discussion: *661 + comment: *667 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -115405,7 +115803,7 @@ x-webhooks: type: string enum: - created - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -115490,7 +115888,7 @@ x-webhooks: type: string enum: - deleted - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -115593,7 +115991,7 @@ x-webhooks: type: string required: - from - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -115678,10 +116076,10 @@ x-webhooks: type: string enum: - labeled - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 - label: &664 + label: &669 title: Label type: object properties: @@ -115796,7 +116194,7 @@ x-webhooks: type: string enum: - locked - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -115881,7 +116279,7 @@ x-webhooks: type: string enum: - pinned - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -115966,7 +116364,7 @@ x-webhooks: type: string enum: - reopened - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -116054,12 +116452,12 @@ x-webhooks: changes: type: object properties: - new_discussion: *661 + new_discussion: *666 new_repository: *645 required: - new_discussion - new_repository - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -116145,8 +116543,8 @@ x-webhooks: type: string enum: - unanswered - discussion: *661 - old_answer: *663 + discussion: *666 + old_answer: *668 organization: *644 repository: *645 sender: *646 @@ -116229,10 +116627,10 @@ x-webhooks: type: string enum: - unlabeled - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 - label: *664 + label: *669 organization: *644 repository: *645 sender: *646 @@ -116316,7 +116714,7 @@ x-webhooks: type: string enum: - unlocked - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -116401,7 +116799,7 @@ x-webhooks: type: string enum: - unpinned - discussion: *661 + discussion: *666 enterprise: *642 installation: *643 organization: *644 @@ -117401,7 +117799,7 @@ x-webhooks: enterprise: *642 installation: *22 organization: *644 - repositories: &666 + repositories: &671 description: An array of repository objects that the installation can access. type: array @@ -117428,7 +117826,7 @@ x-webhooks: - full_name - private repository: *645 - requester: *665 + requester: *670 sender: *646 required: - action @@ -117506,7 +117904,7 @@ x-webhooks: enterprise: *642 installation: *22 organization: *644 - repositories: *666 + repositories: *671 repository: *645 requester: nullable: true @@ -117586,7 +117984,7 @@ x-webhooks: enterprise: *642 installation: *22 organization: *644 - repositories: *666 + repositories: *671 repository: *645 requester: nullable: true @@ -117666,7 +118064,7 @@ x-webhooks: enterprise: *642 installation: *22 organization: *644 - repositories_added: &667 + repositories_added: &672 description: An array of repository objects, which were added to the installation. type: array @@ -117713,14 +118111,14 @@ x-webhooks: description: Whether the repository is private or public. type: boolean repository: *645 - repository_selection: &668 + repository_selection: &673 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *665 + requester: *670 sender: *646 required: - action @@ -117802,7 +118200,7 @@ x-webhooks: enterprise: *642 installation: *22 organization: *644 - repositories_added: *667 + repositories_added: *672 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -117830,8 +118228,8 @@ x-webhooks: - full_name - private repository: *645 - repository_selection: *668 - requester: *665 + repository_selection: *673 + requester: *670 sender: *646 required: - action @@ -117913,7 +118311,7 @@ x-webhooks: enterprise: *642 installation: *22 organization: *644 - repositories: *666 + repositories: *671 repository: *645 requester: nullable: true @@ -118176,7 +118574,7 @@ x-webhooks: enterprise: *642 installation: *22 organization: *644 - repositories: *666 + repositories: *671 repository: *645 requester: nullable: true @@ -119635,7 +120033,7 @@ x-webhooks: type: string enum: - deleted - comment: &669 + comment: &674 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -121002,7 +121400,7 @@ x-webhooks: type: string enum: - edited - changes: &694 + changes: &699 description: The changes to the comment. type: object properties: @@ -121014,7 +121412,7 @@ x-webhooks: type: string required: - from - comment: *669 + comment: *674 enterprise: *642 installation: *643 issue: @@ -122225,10 +122623,10 @@ x-webhooks: type: string enum: - assigned - assignee: *665 + assignee: *670 enterprise: *642 installation: *643 - issue: &672 + issue: &677 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -126176,7 +126574,7 @@ x-webhooks: url: type: string format: uri - milestone: &670 + milestone: &675 title: Milestone description: A collection of related issues and pull requests. type: object @@ -127308,7 +127706,7 @@ x-webhooks: - active_lock_reason - body - reactions - label: *664 + label: *669 organization: *644 repository: *645 sender: *646 @@ -128285,7 +128683,7 @@ x-webhooks: - active_lock_reason - body - reactions - label: *664 + label: *669 organization: *644 repository: *645 sender: *646 @@ -130233,7 +130631,7 @@ x-webhooks: url: type: string format: uri - milestone: *670 + milestone: *675 organization: *644 repository: *645 sender: *646 @@ -132644,7 +133042,7 @@ x-webhooks: - pinned enterprise: *642 installation: *643 - issue: &671 + issue: &676 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -135944,7 +136342,7 @@ x-webhooks: - new_repository enterprise: *642 installation: *643 - issue: *671 + issue: *676 organization: *644 repository: *645 sender: *646 @@ -136027,7 +136425,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &697 + assignee: &702 title: User type: object nullable: true @@ -136097,7 +136495,7 @@ x-webhooks: - id enterprise: *642 installation: *643 - issue: *672 + issue: *677 organization: *644 repository: *645 sender: *646 @@ -136180,8 +136578,8 @@ x-webhooks: - unlabeled enterprise: *642 installation: *643 - issue: *672 - label: *664 + issue: *677 + label: *669 organization: *644 repository: *645 sender: *646 @@ -137238,7 +137636,7 @@ x-webhooks: - unpinned enterprise: *642 installation: *643 - issue: *671 + issue: *676 organization: *644 repository: *645 sender: *646 @@ -137321,7 +137719,7 @@ x-webhooks: - created enterprise: *642 installation: *643 - label: *664 + label: *669 organization: *644 repository: *645 sender: *646 @@ -137403,7 +137801,7 @@ x-webhooks: - deleted enterprise: *642 installation: *643 - label: *664 + label: *669 organization: *644 repository: *645 sender: *646 @@ -137517,7 +137915,7 @@ x-webhooks: - from enterprise: *642 installation: *643 - label: *664 + label: *669 organization: *644 repository: *645 sender: *646 @@ -137603,7 +138001,7 @@ x-webhooks: type: string enterprise: *642 installation: *643 - marketplace_purchase: &673 + marketplace_purchase: &678 title: Marketplace Purchase type: object required: @@ -137687,7 +138085,7 @@ x-webhooks: unit_count: type: integer organization: *644 - previous_marketplace_purchase: &674 + previous_marketplace_purchase: &679 title: Marketplace Purchase type: object properties: @@ -137849,7 +138247,7 @@ x-webhooks: type: string enterprise: *642 installation: *643 - marketplace_purchase: *673 + marketplace_purchase: *678 organization: *644 previous_marketplace_purchase: title: Marketplace Purchase @@ -138017,7 +138415,7 @@ x-webhooks: type: string enterprise: *642 installation: *643 - marketplace_purchase: *673 + marketplace_purchase: *678 organization: *644 previous_marketplace_purchase: title: Marketplace Purchase @@ -138265,7 +138663,7 @@ x-webhooks: unit_count: type: integer organization: *644 - previous_marketplace_purchase: *674 + previous_marketplace_purchase: *679 repository: *645 sender: *646 required: @@ -138348,9 +138746,9 @@ x-webhooks: type: string enterprise: *642 installation: *643 - marketplace_purchase: *673 + marketplace_purchase: *678 organization: *644 - previous_marketplace_purchase: *674 + previous_marketplace_purchase: *679 repository: *645 sender: *646 required: @@ -138455,7 +138853,7 @@ x-webhooks: - to enterprise: *642 installation: *643 - member: *665 + member: *670 organization: *644 repository: *645 sender: *646 @@ -138559,7 +138957,7 @@ x-webhooks: nullable: true enterprise: *642 installation: *643 - member: *665 + member: *670 organization: *644 repository: *645 sender: *646 @@ -138642,7 +139040,7 @@ x-webhooks: - removed enterprise: *642 installation: *643 - member: *665 + member: *670 organization: *644 repository: *645 sender: *646 @@ -138724,7 +139122,7 @@ x-webhooks: - added enterprise: *642 installation: *643 - member: *665 + member: *670 organization: *644 repository: *645 scope: @@ -138800,7 +139198,7 @@ x-webhooks: required: - login - id - team: &675 + team: &680 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -138992,7 +139390,7 @@ x-webhooks: - removed enterprise: *642 installation: *643 - member: *665 + member: *670 organization: *644 repository: *645 scope: @@ -139069,7 +139467,7 @@ x-webhooks: required: - login - id - team: *675 + team: *680 required: - action - scope @@ -139152,7 +139550,7 @@ x-webhooks: enum: - checks_requested installation: *643 - merge_group: &677 + merge_group: &682 type: object title: Merge Group description: 'A group of pull requests that the merge queue has @@ -139173,7 +139571,7 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *676 + head_commit: *681 required: - head_sha - head_ref @@ -139268,7 +139666,7 @@ x-webhooks: - invalidated - dequeued installation: *643 - merge_group: *677 + merge_group: *682 organization: *644 repository: *645 sender: *646 @@ -139459,8 +139857,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *678 - required: *679 + properties: *683 + required: *684 nullable: true sender: *646 required: @@ -139543,7 +139941,7 @@ x-webhooks: - closed enterprise: *642 installation: *643 - milestone: *670 + milestone: *675 organization: *644 repository: *645 sender: *646 @@ -139626,7 +140024,7 @@ x-webhooks: - created enterprise: *642 installation: *643 - milestone: &680 + milestone: &685 title: Milestone description: A collection of related issues and pull requests. type: object @@ -139843,7 +140241,7 @@ x-webhooks: - deleted enterprise: *642 installation: *643 - milestone: *670 + milestone: *675 organization: *644 repository: *645 sender: *646 @@ -139957,7 +140355,7 @@ x-webhooks: - from enterprise: *642 installation: *643 - milestone: *670 + milestone: *675 organization: *644 repository: *645 sender: *646 @@ -140041,7 +140439,7 @@ x-webhooks: - opened enterprise: *642 installation: *643 - milestone: *680 + milestone: *685 organization: *644 repository: *645 sender: *646 @@ -140122,7 +140520,7 @@ x-webhooks: type: string enum: - blocked - blocked_user: *665 + blocked_user: *670 enterprise: *642 installation: *643 organization: *644 @@ -140205,7 +140603,7 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *665 + blocked_user: *670 enterprise: *642 installation: *643 organization: *644 @@ -140290,7 +140688,7 @@ x-webhooks: - deleted enterprise: *642 installation: *643 - membership: &681 + membership: &686 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -140460,7 +140858,7 @@ x-webhooks: - member_added enterprise: *642 installation: *643 - membership: *681 + membership: *686 organization: *644 repository: *645 sender: *646 @@ -140659,7 +141057,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - user: *665 + user: *670 required: - action - invitation @@ -140739,7 +141137,7 @@ x-webhooks: - member_removed enterprise: *642 installation: *643 - membership: *681 + membership: *686 organization: *644 repository: *645 sender: *646 @@ -140830,7 +141228,7 @@ x-webhooks: type: string enterprise: *642 installation: *643 - membership: *681 + membership: *686 organization: *644 repository: *645 sender: *646 @@ -141403,7 +141801,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &682 + items: &687 title: Ruby Gems metadata type: object properties: @@ -141923,7 +142321,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *682 + items: *687 source_url: type: string format: uri @@ -142252,7 +142650,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &683 + personal_access_token_request: &688 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -142467,7 +142865,7 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *683 + personal_access_token_request: *688 enterprise: *642 organization: *644 sender: *646 @@ -142548,7 +142946,7 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *683 + personal_access_token_request: *688 enterprise: *642 organization: *644 sender: *646 @@ -142628,7 +143026,7 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *683 + personal_access_token_request: *688 organization: *644 enterprise: *642 sender: *646 @@ -142736,7 +143134,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *684 + last_response: *689 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -143017,7 +143415,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project_card: &685 + project_card: &690 title: Project Card type: object properties: @@ -143218,7 +143616,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project_card: *685 + project_card: *690 repository: *645 sender: *646 required: @@ -143427,8 +143825,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *678 - required: *679 + properties: *683 + required: *684 nullable: true sender: *646 required: @@ -143525,7 +143923,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project_card: *685 + project_card: *690 repository: *645 sender: *646 required: @@ -143893,7 +144291,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project: &687 + project: &692 title: Project type: object properties: @@ -144098,7 +144496,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project_column: &686 + project_column: &691 title: Project Column type: object properties: @@ -144219,15 +144617,15 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project_column: *686 + project_column: *691 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *678 - required: *679 + properties: *683 + required: *684 nullable: true sender: *646 required: @@ -144320,7 +144718,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project_column: *686 + project_column: *691 repository: *645 sender: *646 required: @@ -144404,7 +144802,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project_column: *686 + project_column: *691 repository: *645 sender: *646 required: @@ -144488,7 +144886,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project: *687 + project: *692 repository: *645 sender: *646 required: @@ -144572,15 +144970,15 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project: *687 + project: *692 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *678 - required: *679 + properties: *683 + required: *684 nullable: true sender: *646 required: @@ -144685,7 +145083,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project: *687 + project: *692 repository: *645 sender: *646 required: @@ -144768,7 +145166,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - project: *687 + project: *692 repository: *645 sender: *646 required: @@ -144851,7 +145249,7 @@ x-webhooks: - closed installation: *643 organization: *644 - projects_v2: &688 + projects_v2: &693 title: Projects v2 Project description: A projects v2 project type: object @@ -144995,7 +145393,7 @@ x-webhooks: - created installation: *643 organization: *644 - projects_v2: *688 + projects_v2: *693 sender: *646 required: - action @@ -145077,7 +145475,7 @@ x-webhooks: - deleted installation: *643 organization: *644 - projects_v2: *688 + projects_v2: *693 sender: *646 required: - action @@ -145195,7 +145593,7 @@ x-webhooks: type: string installation: *643 organization: *644 - projects_v2: *688 + projects_v2: *693 sender: *646 required: - action @@ -145277,7 +145675,7 @@ x-webhooks: type: string enum: - archived - changes: &690 + changes: &695 type: object properties: archived_at: @@ -145293,7 +145691,7 @@ x-webhooks: format: date-time installation: *643 organization: *644 - projects_v2_item: &689 + projects_v2_item: &694 title: Projects v2 Item description: An item belonging to a project type: object @@ -145428,7 +145826,7 @@ x-webhooks: type: string installation: *643 organization: *644 - projects_v2_item: *689 + projects_v2_item: *694 sender: *646 required: - action @@ -145511,7 +145909,7 @@ x-webhooks: - created installation: *643 organization: *644 - projects_v2_item: *689 + projects_v2_item: *694 sender: *646 required: - action @@ -145593,7 +145991,7 @@ x-webhooks: - deleted installation: *643 organization: *644 - projects_v2_item: *689 + projects_v2_item: *694 sender: *646 required: - action @@ -145703,7 +146101,7 @@ x-webhooks: - body installation: *643 organization: *644 - projects_v2_item: *689 + projects_v2_item: *694 sender: *646 required: - action @@ -145799,7 +146197,7 @@ x-webhooks: nullable: true installation: *643 organization: *644 - projects_v2_item: *689 + projects_v2_item: *694 sender: *646 required: - action @@ -145881,10 +146279,10 @@ x-webhooks: type: string enum: - restored - changes: *690 + changes: *695 installation: *643 organization: *644 - projects_v2_item: *689 + projects_v2_item: *694 sender: *646 required: - action @@ -145967,7 +146365,7 @@ x-webhooks: - reopened installation: *643 organization: *644 - projects_v2: *688 + projects_v2: *693 sender: *646 required: - action @@ -146118,10 +146516,10 @@ x-webhooks: type: string enum: - assigned - assignee: *665 + assignee: *670 enterprise: *642 installation: *643 - number: &691 + number: &696 description: The pull request number. type: integer organization: *644 @@ -153143,9 +153541,9 @@ x-webhooks: - closed enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 - pull_request: &692 + pull_request: &697 allOf: - *507 - type: object @@ -153292,9 +153690,9 @@ x-webhooks: - converted_to_draft enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 - pull_request: *692 + pull_request: *697 repository: *645 sender: *646 required: @@ -153377,9 +153775,9 @@ x-webhooks: - demilestoned enterprise: *642 milestone: *489 - number: *691 + number: *696 organization: *644 - pull_request: &693 + pull_request: &698 title: Pull Request type: object properties: @@ -158072,9 +158470,9 @@ x-webhooks: - from enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 - pull_request: *692 + pull_request: *697 repository: *645 sender: *646 required: @@ -160483,8 +160881,8 @@ x-webhooks: - labeled enterprise: *642 installation: *643 - label: *664 - number: *691 + label: *669 + number: *696 organization: *644 pull_request: title: Pull Request @@ -162825,7 +163223,7 @@ x-webhooks: - locked enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 pull_request: title: Pull Request @@ -165163,9 +165561,9 @@ x-webhooks: - milestoned enterprise: *642 milestone: *489 - number: *691 + number: *696 organization: *644 - pull_request: *693 + pull_request: *698 repository: *645 sender: *646 required: @@ -165247,9 +165645,9 @@ x-webhooks: - opened enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 - pull_request: *692 + pull_request: *697 repository: *645 sender: *646 required: @@ -165333,9 +165731,9 @@ x-webhooks: - ready_for_review enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 - pull_request: *692 + pull_request: *697 repository: *645 sender: *646 required: @@ -165418,9 +165816,9 @@ x-webhooks: - reopened enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 - pull_request: *692 + pull_request: *697 repository: *645 sender: *646 required: @@ -168013,7 +168411,7 @@ x-webhooks: type: string enum: - deleted - comment: &695 + comment: &700 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -170512,8 +170910,8 @@ x-webhooks: type: string enum: - edited - changes: *694 - comment: *695 + changes: *699 + comment: *700 enterprise: *642 installation: *643 organization: *644 @@ -177159,7 +177557,7 @@ x-webhooks: - auto_merge - active_lock_reason repository: *645 - review: &696 + review: &701 description: The review that was affected. type: object properties: @@ -189124,7 +189522,7 @@ x-webhooks: - auto_merge - active_lock_reason repository: *645 - review: *696 + review: *701 sender: *646 required: - action @@ -194053,7 +194451,7 @@ x-webhooks: type: string enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 pull_request: title: Pull Request @@ -196382,10 +196780,10 @@ x-webhooks: type: string enum: - unassigned - assignee: *697 + assignee: *702 enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 pull_request: title: Pull Request @@ -198725,8 +199123,8 @@ x-webhooks: - unlabeled enterprise: *642 installation: *643 - label: *664 - number: *691 + label: *669 + number: *696 organization: *644 pull_request: title: Pull Request @@ -201058,7 +201456,7 @@ x-webhooks: - unlocked enterprise: *642 installation: *643 - number: *691 + number: *696 organization: *644 pull_request: title: Pull Request @@ -204604,7 +205002,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *682 + items: *687 summary: type: string tag_name: @@ -205039,7 +205437,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *682 + items: *687 summary: type: string tag_name: @@ -205168,7 +205566,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - release: &698 + release: &703 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -205551,7 +205949,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - release: *698 + release: *703 repository: *645 sender: *646 required: @@ -205663,7 +206061,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - release: *698 + release: *703 repository: *645 sender: *646 required: @@ -206130,7 +206528,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - release: &699 + release: &704 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -206513,7 +206911,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - release: *698 + release: *703 repository: *645 sender: *646 required: @@ -206593,7 +206991,7 @@ x-webhooks: enterprise: *642 installation: *643 organization: *644 - release: *699 + release: *704 repository: *645 sender: *646 required: @@ -208242,7 +208640,7 @@ x-webhooks: type: string enum: - create - alert: &700 + alert: &705 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -208649,7 +209047,7 @@ x-webhooks: type: string enum: - reopen - alert: *700 + alert: *705 enterprise: *642 installation: *643 organization: *644 @@ -208932,7 +209330,7 @@ x-webhooks: type: string enum: - created - alert: &701 + alert: &706 type: object properties: number: *71 @@ -209096,9 +209494,9 @@ x-webhooks: type: string enum: - created - alert: *701 + alert: *706 installation: *643 - location: *702 + location: *707 organization: *644 repository: *645 sender: *646 @@ -209336,7 +209734,7 @@ x-webhooks: type: string enum: - reopened - alert: *701 + alert: *706 enterprise: *642 installation: *643 organization: *644 @@ -209418,7 +209816,7 @@ x-webhooks: type: string enum: - resolved - alert: *701 + alert: *706 enterprise: *642 installation: *643 organization: *644 @@ -209500,7 +209898,7 @@ x-webhooks: type: string enum: - validated - alert: *701 + alert: *706 enterprise: *642 installation: *643 organization: *644 @@ -209584,7 +209982,7 @@ x-webhooks: installation: *643 organization: *644 repository: *645 - security_advisory: &703 + security_advisory: &708 description: The details of the security advisory, including summary, description, and severity. type: object @@ -209770,7 +210168,7 @@ x-webhooks: installation: *643 organization: *644 repository: *645 - security_advisory: *703 + security_advisory: *708 sender: *646 required: - action @@ -210116,7 +210514,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - sponsorship: &704 + sponsorship: &709 type: object properties: created_at: @@ -210416,7 +210814,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - sponsorship: *704 + sponsorship: *709 required: - action - sponsorship @@ -210509,7 +210907,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - sponsorship: *704 + sponsorship: *709 required: - action - changes @@ -210586,7 +210984,7 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &705 + effective_date: &710 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. @@ -210596,7 +210994,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - sponsorship: *704 + sponsorship: *709 required: - action - sponsorship @@ -210670,7 +211068,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &706 + changes: &711 type: object properties: tier: @@ -210714,13 +211112,13 @@ x-webhooks: - from required: - tier - effective_date: *705 + effective_date: *710 enterprise: *642 installation: *643 organization: *644 repository: *645 sender: *646 - sponsorship: *704 + sponsorship: *709 required: - action - changes @@ -210797,13 +211195,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *706 + changes: *711 enterprise: *642 installation: *643 organization: *644 repository: *645 sender: *646 - sponsorship: *704 + sponsorship: *709 required: - action - changes @@ -211497,7 +211895,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - team: &707 + team: &712 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -212144,7 +212542,7 @@ x-webhooks: - topics - visibility sender: *646 - team: *707 + team: *712 required: - action - team @@ -212677,7 +213075,7 @@ x-webhooks: - topics - visibility sender: *646 - team: *707 + team: *712 required: - action - team @@ -213211,7 +213609,7 @@ x-webhooks: - topics - visibility sender: *646 - team: *707 + team: *712 required: - action - team @@ -213812,7 +214210,7 @@ x-webhooks: - topics - visibility sender: *646 - team: *707 + team: *712 required: - action - changes @@ -214347,7 +214745,7 @@ x-webhooks: - topics - visibility sender: *646 - team: *707 + team: *712 required: - action - team @@ -215692,7 +216090,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - workflow: *660 + workflow: *665 workflow_run: title: Workflow Run type: object @@ -216687,7 +217085,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - workflow: *660 + workflow: *665 workflow_run: title: Workflow Run type: object @@ -217676,7 +218074,7 @@ x-webhooks: organization: *644 repository: *645 sender: *646 - workflow: *660 + workflow: *665 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index 1b2492114..c50b18c71 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -13144,7 +13144,7 @@ "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand code matching policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can configure and view details about the organization's Copilot Business subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -13201,7 +13201,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).\n\nOnly organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription.\nOnly organization owners can view assigned seats.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -13284,7 +13284,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -13384,7 +13384,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -13486,7 +13486,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -13586,7 +13586,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -17035,7 +17035,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOrganization owners can view GitHub Copilot seat assignment details for members in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -17144,7 +17144,7 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], @@ -20204,7 +20204,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -38489,11 +38491,18 @@ } }, { - "$ref": "#/components/parameters/since" + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } }, { "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -71554,6 +71563,471 @@ } } }, + "bypass-request-push-ruleset-cancelled": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A push ruleset bypass request was cancelled.", + "operationId": "exemption-request-push-ruleset/cancelled", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-exemption-request-cancelled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_push_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-push-ruleset-completed": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A push ruleset bypass request was completed.", + "operationId": "exemption-request-push-ruleset/completed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-exemption-request-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_push_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-push-ruleset-created": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A push ruleset bypass request was created.", + "operationId": "exemption-request-push-ruleset/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-exemption-request-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_push_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-push-ruleset-response-dismissed": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A push ruleset bypass response was dismissed.", + "operationId": "exemption-request-push-ruleset/response-dismissed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_push_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-push-ruleset-response-submitted": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A response either approving or rejecting the push ruleset bypass request was submitted.", + "operationId": "exemption-request-push-ruleset/response-submitted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_push_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "bypass-request-secret-scanning-cancelled": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", @@ -104288,6 +104762,62 @@ "updated_at" ] }, + "enterprise-team": { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "example": "disabled | all" + }, + "group_id": { + "nullable": true, + "type": "integer", + "example": 1 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/dc/teams/justice-league" + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "sync_to_organizations", + "name", + "html_url", + "slug", + "created_at", + "updated_at" + ] + }, "copilot-seat-details": { "title": "Copilot Business Seat Detail", "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", @@ -104309,11 +104839,24 @@ } ] }, + "organization": { + "type": "object", + "description": "The organization to which this seat belongs.", + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/organization-simple" + } + ] + }, "assigning_team": { - "description": "The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually.", + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", "oneOf": [ { "$ref": "#/components/schemas/team" + }, + { + "$ref": "#/components/schemas/enterprise-team" } ], "nullable": true @@ -106074,7 +106617,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index e0008f4ae..ec0579a89 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -9486,12 +9486,12 @@ paths: **Note**: This endpoint is in beta and is subject to change. Gets information about an organization's Copilot subscription, including seat breakdown - and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. + and feature policies. To configure these settings, go to your organization's settings on GitHub.com. For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". - Only organization owners can configure and view details about the organization's Copilot Business subscription. + Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/get-copilot-organization-details @@ -9531,11 +9531,10 @@ paths: description: |- **Note**: This endpoint is in beta and is subject to change. - Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + Only organization owners can view assigned seats. - Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. - - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/list-copilot-seats @@ -9596,13 +9595,13 @@ paths: Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-teams @@ -9681,9 +9680,9 @@ paths: For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can cancel Copilot seats for their organization members. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-teams @@ -9759,13 +9758,13 @@ paths: Purchases a GitHub Copilot seat for each user specified. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-users @@ -9844,9 +9843,9 @@ paths: For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can cancel Copilot seats for their organization members. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-users @@ -12349,9 +12348,9 @@ paths: Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. - Organization owners can view GitHub Copilot seat assignment details for members in their organization. + Only organization owners can view Copilot seat assignment details for members of their organization. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/get-copilot-seat-details-for-user @@ -12432,10 +12431,10 @@ paths: the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email - will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user - is limited to 50 organization invitations per 24 hour period. If the organization - is more than one month old or on a paid plan, the limit is 500 invitations - per 24 hour period." + will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners + are limited to creating 50 organization invitations for an organization within + a 24 hour period. If the organization is more than one month old or on a paid + plan, the limit is 500 invitations per 24 hour period." tags: - orgs operationId: orgs/set-membership-for-user @@ -14647,6 +14646,8 @@ paths: enum: - string - single_select + - multi_select + - true_false description: The type of the value for the property required: type: boolean @@ -27886,10 +27887,22 @@ paths: required: false schema: type: string - - "$ref": "#/components/parameters/since" + - name: since + description: 'Only show results that were last updated after the given time. + This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must + be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may + be returned.' + in: query + required: false + schema: + type: string + format: date-time - name: until description: 'Only commits before this date will be returned. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 + (inclusive) or unexpected results may be returned.' in: query required: false schema: @@ -51642,6 +51655,347 @@ x-webhooks: - repository - organization - app + bypass-request-push-ruleset-cancelled: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass a set of push rules. + + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A push ruleset bypass request was cancelled. + operationId: exemption-request-push-ruleset/cancelled + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-cancelled" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_push_ruleset + supported-webhook-types: + - repository + - organization + - app + bypass-request-push-ruleset-completed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass a set of push rules. + + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A push ruleset bypass request was completed. + operationId: exemption-request-push-ruleset/completed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-completed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_push_ruleset + supported-webhook-types: + - repository + - organization + - app + bypass-request-push-ruleset-created: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass a set of push rules. + + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A push ruleset bypass request was created. + operationId: exemption-request-push-ruleset/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_push_ruleset + supported-webhook-types: + - repository + - organization + - app + bypass-request-push-ruleset-response-dismissed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass a set of push rules. + + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A push ruleset bypass response was dismissed. + operationId: exemption-request-push-ruleset/response-dismissed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_push_ruleset + supported-webhook-types: + - repository + - organization + - app + bypass-request-push-ruleset-response-submitted: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass a set of push rules. + + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A response either approving or rejecting the push ruleset bypass + request was submitted. + operationId: exemption-request-push-ruleset/response-submitted + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_push_ruleset + supported-webhook-types: + - repository + - organization + - app bypass-request-secret-scanning-cancelled: post: summary: |- @@ -75871,6 +76225,49 @@ components: - type - created_at - updated_at + enterprise-team: + title: Enterprise Team + description: Group of enterprise owners and/or members + type: object + properties: + id: + type: integer + name: + type: string + slug: + type: string + url: + type: string + format: uri + sync_to_organizations: + type: string + example: disabled | all + group_id: + nullable: true + type: integer + example: 1 + html_url: + type: string + format: uri + example: https://github.com/enterprises/dc/teams/justice-league + members_url: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - url + - members_url + - sync_to_organizations + - name + - html_url + - slug + - created_at + - updated_at copilot-seat-details: title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, @@ -75885,11 +76282,18 @@ components: - "$ref": "#/components/schemas/simple-user" - "$ref": "#/components/schemas/team" - "$ref": "#/components/schemas/organization" + organization: + type: object + description: The organization to which this seat belongs. + nullable: true + oneOf: + - "$ref": "#/components/schemas/organization-simple" assigning_team: - description: The team that granted access to GitHub Copilot to the assignee. - This will be null if the user was assigned a seat individually. + description: The team through which the assignee is granted access to GitHub + Copilot, if applicable. oneOf: - "$ref": "#/components/schemas/team" + - "$ref": "#/components/schemas/enterprise-team" nullable: true pending_cancellation_date: type: string @@ -77270,6 +77674,8 @@ components: enum: - string - single_select + - multi_select + - true_false description: The type of the value for the property required: type: boolean diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json index 1b2492114..c50b18c71 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -13144,7 +13144,7 @@ "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand code matching policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can configure and view details about the organization's Copilot Business subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -13201,7 +13201,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).\n\nOnly organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription.\nOnly organization owners can view assigned seats.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -13284,7 +13284,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -13384,7 +13384,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -13486,7 +13486,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -13586,7 +13586,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -17035,7 +17035,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOrganization owners can view GitHub Copilot seat assignment details for members in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -17144,7 +17144,7 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], @@ -20204,7 +20204,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -38489,11 +38491,18 @@ } }, { - "$ref": "#/components/parameters/since" + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } }, { "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -71554,6 +71563,471 @@ } } }, + "bypass-request-push-ruleset-cancelled": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A push ruleset bypass request was cancelled.", + "operationId": "exemption-request-push-ruleset/cancelled", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-exemption-request-cancelled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_push_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-push-ruleset-completed": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A push ruleset bypass request was completed.", + "operationId": "exemption-request-push-ruleset/completed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-exemption-request-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_push_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-push-ruleset-created": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A push ruleset bypass request was created.", + "operationId": "exemption-request-push-ruleset/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-exemption-request-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_push_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-push-ruleset-response-dismissed": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A push ruleset bypass response was dismissed.", + "operationId": "exemption-request-push-ruleset/response-dismissed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_push_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-push-ruleset-response-submitted": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in beta and subject to change.", + "description": "A response either approving or rejecting the push ruleset bypass request was submitted.", + "operationId": "exemption-request-push-ruleset/response-submitted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_push_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "bypass-request-secret-scanning-cancelled": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", @@ -104288,6 +104762,62 @@ "updated_at" ] }, + "enterprise-team": { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "example": "disabled | all" + }, + "group_id": { + "nullable": true, + "type": "integer", + "example": 1 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/dc/teams/justice-league" + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "sync_to_organizations", + "name", + "html_url", + "slug", + "created_at", + "updated_at" + ] + }, "copilot-seat-details": { "title": "Copilot Business Seat Detail", "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", @@ -104309,11 +104839,24 @@ } ] }, + "organization": { + "type": "object", + "description": "The organization to which this seat belongs.", + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/organization-simple" + } + ] + }, "assigning_team": { - "description": "The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually.", + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", "oneOf": [ { "$ref": "#/components/schemas/team" + }, + { + "$ref": "#/components/schemas/enterprise-team" } ], "nullable": true @@ -106074,7 +106617,9 @@ "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index e0008f4ae..ec0579a89 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -9486,12 +9486,12 @@ paths: **Note**: This endpoint is in beta and is subject to change. Gets information about an organization's Copilot subscription, including seat breakdown - and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. + and feature policies. To configure these settings, go to your organization's settings on GitHub.com. For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". - Only organization owners can configure and view details about the organization's Copilot Business subscription. + Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/get-copilot-organization-details @@ -9531,11 +9531,10 @@ paths: description: |- **Note**: This endpoint is in beta and is subject to change. - Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + Only organization owners can view assigned seats. - Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. - - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/list-copilot-seats @@ -9596,13 +9595,13 @@ paths: Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-teams @@ -9681,9 +9680,9 @@ paths: For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can cancel Copilot seats for their organization members. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-teams @@ -9759,13 +9758,13 @@ paths: Purchases a GitHub Copilot seat for each user specified. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-users @@ -9844,9 +9843,9 @@ paths: For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners can configure GitHub Copilot in their organization. + Only organization owners can cancel Copilot seats for their organization members. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-users @@ -12349,9 +12348,9 @@ paths: Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. - Organization owners can view GitHub Copilot seat assignment details for members in their organization. + Only organization owners can view Copilot seat assignment details for members of their organization. - OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/get-copilot-seat-details-for-user @@ -12432,10 +12431,10 @@ paths: the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email - will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user - is limited to 50 organization invitations per 24 hour period. If the organization - is more than one month old or on a paid plan, the limit is 500 invitations - per 24 hour period." + will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners + are limited to creating 50 organization invitations for an organization within + a 24 hour period. If the organization is more than one month old or on a paid + plan, the limit is 500 invitations per 24 hour period." tags: - orgs operationId: orgs/set-membership-for-user @@ -14647,6 +14646,8 @@ paths: enum: - string - single_select + - multi_select + - true_false description: The type of the value for the property required: type: boolean @@ -27886,10 +27887,22 @@ paths: required: false schema: type: string - - "$ref": "#/components/parameters/since" + - name: since + description: 'Only show results that were last updated after the given time. + This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must + be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may + be returned.' + in: query + required: false + schema: + type: string + format: date-time - name: until description: 'Only commits before this date will be returned. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 + (inclusive) or unexpected results may be returned.' in: query required: false schema: @@ -51642,6 +51655,347 @@ x-webhooks: - repository - organization - app + bypass-request-push-ruleset-cancelled: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass a set of push rules. + + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A push ruleset bypass request was cancelled. + operationId: exemption-request-push-ruleset/cancelled + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-cancelled" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_push_ruleset + supported-webhook-types: + - repository + - organization + - app + bypass-request-push-ruleset-completed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass a set of push rules. + + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A push ruleset bypass request was completed. + operationId: exemption-request-push-ruleset/completed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-completed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_push_ruleset + supported-webhook-types: + - repository + - organization + - app + bypass-request-push-ruleset-created: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass a set of push rules. + + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A push ruleset bypass request was created. + operationId: exemption-request-push-ruleset/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_push_ruleset + supported-webhook-types: + - repository + - organization + - app + bypass-request-push-ruleset-response-dismissed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass a set of push rules. + + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A push ruleset bypass response was dismissed. + operationId: exemption-request-push-ruleset/response-dismissed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_push_ruleset + supported-webhook-types: + - repository + - organization + - app + bypass-request-push-ruleset-response-submitted: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass a set of push rules. + + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + + Note: Delegated bypass for push rules is currently in beta and subject to change. + description: A response either approving or rejecting the push ruleset bypass + request was submitted. + operationId: exemption-request-push-ruleset/response-submitted + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_push_ruleset + supported-webhook-types: + - repository + - organization + - app bypass-request-secret-scanning-cancelled: post: summary: |- @@ -75871,6 +76225,49 @@ components: - type - created_at - updated_at + enterprise-team: + title: Enterprise Team + description: Group of enterprise owners and/or members + type: object + properties: + id: + type: integer + name: + type: string + slug: + type: string + url: + type: string + format: uri + sync_to_organizations: + type: string + example: disabled | all + group_id: + nullable: true + type: integer + example: 1 + html_url: + type: string + format: uri + example: https://github.com/enterprises/dc/teams/justice-league + members_url: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - url + - members_url + - sync_to_organizations + - name + - html_url + - slug + - created_at + - updated_at copilot-seat-details: title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, @@ -75885,11 +76282,18 @@ components: - "$ref": "#/components/schemas/simple-user" - "$ref": "#/components/schemas/team" - "$ref": "#/components/schemas/organization" + organization: + type: object + description: The organization to which this seat belongs. + nullable: true + oneOf: + - "$ref": "#/components/schemas/organization-simple" assigning_team: - description: The team that granted access to GitHub Copilot to the assignee. - This will be null if the user was assigned a seat individually. + description: The team through which the assignee is granted access to GitHub + Copilot, if applicable. oneOf: - "$ref": "#/components/schemas/team" + - "$ref": "#/components/schemas/enterprise-team" nullable: true pending_cancellation_date: type: string @@ -77270,6 +77674,8 @@ components: enum: - string - single_select + - multi_select + - true_false description: The type of the value for the property required: type: boolean diff --git a/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json b/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json index 9ffacdca5..1c314db8f 100644 --- a/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json +++ b/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json @@ -93024,7 +93024,7 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.10/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.10/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], @@ -197958,7 +197958,7 @@ }, { "name": "since", - "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -197968,7 +197968,7 @@ }, { "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { diff --git a/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml b/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml index 454fd6fb5..3fc29ea3e 100644 --- a/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml +++ b/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml @@ -25238,10 +25238,10 @@ paths: the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email - will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user - is limited to 50 organization invitations per 24 hour period. If the organization - is more than one month old or on a paid plan, the limit is 500 invitations - per 24 hour period." + will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners + are limited to creating 50 organization invitations for an organization within + a 24 hour period. If the organization is more than one month old or on a paid + plan, the limit is 500 invitations per 24 hour period." tags: - orgs operationId: orgs/set-membership-for-user @@ -48237,10 +48237,22 @@ paths: required: false schema: type: string - - *109 + - name: since + description: 'Only show results that were last updated after the given time. + This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must + be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may + be returned.' + in: query + required: false + schema: + type: string + format: date-time - name: until description: 'Only commits before this date will be returned. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 + (inclusive) or unexpected results may be returned.' in: query required: false schema: diff --git a/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.json b/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.json index 9ffacdca5..1c314db8f 100644 --- a/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.json +++ b/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.json @@ -93024,7 +93024,7 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.10/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.10/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], @@ -197958,7 +197958,7 @@ }, { "name": "since", - "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -197968,7 +197968,7 @@ }, { "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { diff --git a/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.yaml b/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.yaml index 454fd6fb5..3fc29ea3e 100644 --- a/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.yaml +++ b/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.yaml @@ -25238,10 +25238,10 @@ paths: the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email - will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user - is limited to 50 organization invitations per 24 hour period. If the organization - is more than one month old or on a paid plan, the limit is 500 invitations - per 24 hour period." + will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners + are limited to creating 50 organization invitations for an organization within + a 24 hour period. If the organization is more than one month old or on a paid + plan, the limit is 500 invitations per 24 hour period." tags: - orgs operationId: orgs/set-membership-for-user @@ -48237,10 +48237,22 @@ paths: required: false schema: type: string - - *109 + - name: since + description: 'Only show results that were last updated after the given time. + This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must + be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may + be returned.' + in: query + required: false + schema: + type: string + format: date-time - name: until description: 'Only commits before this date will be returned. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 + (inclusive) or unexpected results may be returned.' in: query required: false schema: diff --git a/descriptions/ghes-3.10/ghes-3.10.2022-11-28.json b/descriptions/ghes-3.10/ghes-3.10.2022-11-28.json index 708fcc584..8bab0b73f 100644 --- a/descriptions/ghes-3.10/ghes-3.10.2022-11-28.json +++ b/descriptions/ghes-3.10/ghes-3.10.2022-11-28.json @@ -16554,7 +16554,7 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.10/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.10/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], @@ -34118,11 +34118,18 @@ } }, { - "$ref": "#/components/parameters/since" + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } }, { "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { diff --git a/descriptions/ghes-3.10/ghes-3.10.2022-11-28.yaml b/descriptions/ghes-3.10/ghes-3.10.2022-11-28.yaml index 0d83786db..15fe57648 100644 --- a/descriptions/ghes-3.10/ghes-3.10.2022-11-28.yaml +++ b/descriptions/ghes-3.10/ghes-3.10.2022-11-28.yaml @@ -11897,10 +11897,10 @@ paths: the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email - will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user - is limited to 50 organization invitations per 24 hour period. If the organization - is more than one month old or on a paid plan, the limit is 500 invitations - per 24 hour period." + will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners + are limited to creating 50 organization invitations for an organization within + a 24 hour period. If the organization is more than one month old or on a paid + plan, the limit is 500 invitations per 24 hour period." tags: - orgs operationId: orgs/set-membership-for-user @@ -24622,10 +24622,22 @@ paths: required: false schema: type: string - - "$ref": "#/components/parameters/since" + - name: since + description: 'Only show results that were last updated after the given time. + This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must + be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may + be returned.' + in: query + required: false + schema: + type: string + format: date-time - name: until description: 'Only commits before this date will be returned. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 + (inclusive) or unexpected results may be returned.' in: query required: false schema: diff --git a/descriptions/ghes-3.10/ghes-3.10.json b/descriptions/ghes-3.10/ghes-3.10.json index 708fcc584..8bab0b73f 100644 --- a/descriptions/ghes-3.10/ghes-3.10.json +++ b/descriptions/ghes-3.10/ghes-3.10.json @@ -16554,7 +16554,7 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.10/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.10/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], @@ -34118,11 +34118,18 @@ } }, { - "$ref": "#/components/parameters/since" + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } }, { "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { diff --git a/descriptions/ghes-3.10/ghes-3.10.yaml b/descriptions/ghes-3.10/ghes-3.10.yaml index 0d83786db..15fe57648 100644 --- a/descriptions/ghes-3.10/ghes-3.10.yaml +++ b/descriptions/ghes-3.10/ghes-3.10.yaml @@ -11897,10 +11897,10 @@ paths: the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email - will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user - is limited to 50 organization invitations per 24 hour period. If the organization - is more than one month old or on a paid plan, the limit is 500 invitations - per 24 hour period." + will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners + are limited to creating 50 organization invitations for an organization within + a 24 hour period. If the organization is more than one month old or on a paid + plan, the limit is 500 invitations per 24 hour period." tags: - orgs operationId: orgs/set-membership-for-user @@ -24622,10 +24622,22 @@ paths: required: false schema: type: string - - "$ref": "#/components/parameters/since" + - name: since + description: 'Only show results that were last updated after the given time. + This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must + be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may + be returned.' + in: query + required: false + schema: + type: string + format: date-time - name: until description: 'Only commits before this date will be returned. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 + (inclusive) or unexpected results may be returned.' in: query required: false schema: diff --git a/descriptions/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.json b/descriptions/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.json index 9a96d2ea5..4b7088a85 100644 --- a/descriptions/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.json +++ b/descriptions/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.json @@ -94428,7 +94428,7 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.11/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.11/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], @@ -205449,7 +205449,7 @@ }, { "name": "since", - "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -205459,7 +205459,7 @@ }, { "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { diff --git a/descriptions/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.yaml b/descriptions/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.yaml index c999344bd..9f5fb5b46 100644 --- a/descriptions/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.yaml +++ b/descriptions/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.yaml @@ -25817,10 +25817,10 @@ paths: the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email - will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user - is limited to 50 organization invitations per 24 hour period. If the organization - is more than one month old or on a paid plan, the limit is 500 invitations - per 24 hour period." + will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners + are limited to creating 50 organization invitations for an organization within + a 24 hour period. If the organization is more than one month old or on a paid + plan, the limit is 500 invitations per 24 hour period." tags: - orgs operationId: orgs/set-membership-for-user @@ -49981,10 +49981,22 @@ paths: required: false schema: type: string - - *111 + - name: since + description: 'Only show results that were last updated after the given time. + This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must + be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may + be returned.' + in: query + required: false + schema: + type: string + format: date-time - name: until description: 'Only commits before this date will be returned. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + Due to limitations of Git, time{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}