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 38c6854033..a9d68295a5 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" ], @@ -33222,11 +33222,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 +95369,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 +95446,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 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 4e78791e9c..aa0db99bcb 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 @@ -24087,10 +24086,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 +69388,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 +69445,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 diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 38c6854033..a9d68295a5 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" ], @@ -33222,11 +33222,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 +95369,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 +95446,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 diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 4e78791e9c..aa0db99bcb 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 @@ -24087,10 +24086,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 +69388,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 +69445,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 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 9cd44f417d..ba48bb9d02 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" ], @@ -213628,7 +213900,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 +213910,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/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 221f31ba40..ed0ee5b30a 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: @@ -26509,7 +26555,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -29713,7 +29759,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 +30471,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 headers: @@ -32312,9 +32358,9 @@ paths: application/json: schema: type: array - items: *149 + items: *150 examples: - default: *150 + default: *151 headers: Link: *50 x-github: @@ -32360,7 +32406,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -33554,7 +33600,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: response-if-child-teams-exist: &535 value: @@ -34591,7 +34637,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '404': *7 @@ -39410,7 +39456,7 @@ paths: reviewer: anyOf: - *19 - - *123 + - *124 required: - environment - wait_timer @@ -40908,7 +40954,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '404': *7 @@ -41371,7 +41417,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 +41446,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 +42678,7 @@ paths: items: *19 teams: type: array - items: *123 + items: *124 apps: type: array items: *6 @@ -42650,7 +42696,7 @@ paths: items: *19 teams: type: array - items: *123 + items: *124 apps: type: array items: *6 @@ -44044,7 +44090,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 '404': *7 @@ -44104,7 +44150,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 '422': *16 @@ -44165,7 +44211,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 '422': *16 @@ -44225,7 +44271,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 '422': *16 @@ -44261,7 +44307,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '404': *7 x-github: githubCloudOnly: false @@ -44324,7 +44370,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '422': *16 x-github: githubCloudOnly: false @@ -44388,7 +44434,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '422': *16 x-github: githubCloudOnly: false @@ -44451,7 +44497,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '422': *16 x-github: githubCloudOnly: false @@ -49238,7 +49284,7 @@ paths: type: integer codespaces: type: array - items: *155 + items: *156 examples: default: value: @@ -49600,7 +49646,7 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *155 + schema: *156 examples: default: *341 '202': @@ -49608,7 +49654,7 @@ paths: being retried in the background content: application/json: - schema: *155 + schema: *156 examples: default: *341 '400': *15 @@ -51239,10 +51285,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 +51756,7 @@ paths: nullable: true requested_teams: type: array - items: *123 + items: *124 nullable: true head: type: object @@ -54792,18 +54850,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 +54881,8 @@ paths: default: 30 - *41 - *42 - - *131 - *132 + - *133 responses: '200': description: Response @@ -57101,7 +57159,7 @@ paths: reviewer: anyOf: - *19 - - *123 + - *124 required: - id - node_id @@ -60339,7 +60397,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '200': description: Response @@ -60369,7 +60427,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 requestBody: required: true content: @@ -60436,7 +60494,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '204': description: Response @@ -60462,7 +60520,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '200': description: Response @@ -60491,7 +60549,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 requestBody: required: false content: @@ -60537,9 +60595,9 @@ paths: parameters: - *225 - *226 - - *140 - - *18 - *141 + - *18 + - *142 - name: redelivery in: query required: false @@ -60552,9 +60610,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *143 + default: *144 '400': *15 '422': *16 x-github: @@ -60575,16 +60633,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 +60663,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 - *17 responses: '202': *91 @@ -60630,7 +60688,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '204': description: Response @@ -60656,7 +60714,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '204': description: Response @@ -61438,7 +61496,7 @@ paths: application/json: schema: anyOf: - - *147 + - *148 - type: object properties: {} additionalProperties: false @@ -61486,7 +61544,7 @@ paths: description: Response content: application/json: - schema: *147 + schema: *148 examples: default: *415 '409': @@ -61680,7 +61738,7 @@ paths: parameters: - *225 - *226 - - *151 + - *152 requestBody: required: false content: @@ -61842,7 +61900,7 @@ paths: parameters: - *225 - *226 - - *151 + - *152 responses: '204': description: Response @@ -61916,7 +61974,7 @@ paths: required: false schema: type: string - - *152 + - *153 - name: sort description: What to sort results by. in: query @@ -62829,7 +62887,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 +64193,7 @@ paths: properties: *53 required: *54 review_requester: *19 - requested_team: *123 + requested_team: *124 requested_reviewer: *19 required: - review_requester @@ -64182,7 +64240,7 @@ paths: properties: *53 required: *54 review_requester: *19 - requested_team: *123 + requested_team: *124 requested_reviewer: *19 required: - review_requester @@ -71059,7 +71117,7 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *155 + schema: *156 examples: default: *341 '202': @@ -71067,7 +71125,7 @@ paths: being retried in the background content: application/json: - schema: *155 + schema: *156 examples: default: *341 '401': *25 @@ -71713,7 +71771,7 @@ paths: items: *19 teams: type: array - items: *123 + items: *124 required: - users - teams @@ -78033,7 +78091,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -78483,7 +78541,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 headers: @@ -82361,9 +82419,9 @@ paths: application/json: schema: type: array - items: *149 + items: *150 examples: - default: *150 + default: *151 headers: Link: *50 x-github: @@ -82411,7 +82469,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '404': *7 @@ -83134,7 +83192,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: response-if-child-teams-exist: *535 headers: @@ -83605,7 +83663,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '304': *37 '404': *7 '403': *29 @@ -83729,9 +83787,9 @@ paths: type: integer codespaces: type: array - items: *155 + items: *156 examples: - default: *156 + default: *157 '304': *37 '500': *121 '401': *25 @@ -83870,7 +83928,7 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *155 + schema: *156 examples: default: *341 '202': @@ -83878,7 +83936,7 @@ paths: being retried in the background content: application/json: - schema: *155 + schema: *156 examples: default: *341 '401': *25 @@ -84563,13 +84621,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 +84655,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 +84685,7 @@ paths: description: Response content: application/json: - schema: *155 + schema: *156 examples: default: *341 '401': *25 @@ -84651,7 +84709,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 +84738,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 +84817,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 +84853,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 +84900,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 +85729,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 +85769,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 +86162,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '304': *37 @@ -86137,7 +86195,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '304': *37 @@ -86835,12 +86893,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 +86933,7 @@ paths: description: Response content: application/json: - schema: *147 + schema: *148 examples: default: value: @@ -86958,7 +87016,7 @@ paths: - closed - all default: open - - *152 + - *153 - name: sort description: What to sort results by. in: query @@ -86983,7 +87041,7 @@ paths: type: array items: *69 examples: - default: *153 + default: *154 headers: Link: *50 '404': *7 @@ -88406,7 +88464,7 @@ paths: application/json: schema: type: array - items: *159 + items: *123 examples: default: *553 headers: @@ -89420,7 +89478,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 +89501,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 +90282,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: example: ; rel="next" @@ -90643,7 +90701,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -90674,7 +90732,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -90946,7 +91004,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 9cd44f417d..ba48bb9d02 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" ], @@ -213628,7 +213900,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 +213910,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/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 221f31ba40..ed0ee5b30a 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: @@ -26509,7 +26555,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -29713,7 +29759,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 +30471,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 headers: @@ -32312,9 +32358,9 @@ paths: application/json: schema: type: array - items: *149 + items: *150 examples: - default: *150 + default: *151 headers: Link: *50 x-github: @@ -32360,7 +32406,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -33554,7 +33600,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: response-if-child-teams-exist: &535 value: @@ -34591,7 +34637,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '404': *7 @@ -39410,7 +39456,7 @@ paths: reviewer: anyOf: - *19 - - *123 + - *124 required: - environment - wait_timer @@ -40908,7 +40954,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '404': *7 @@ -41371,7 +41417,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 +41446,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 +42678,7 @@ paths: items: *19 teams: type: array - items: *123 + items: *124 apps: type: array items: *6 @@ -42650,7 +42696,7 @@ paths: items: *19 teams: type: array - items: *123 + items: *124 apps: type: array items: *6 @@ -44044,7 +44090,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 '404': *7 @@ -44104,7 +44150,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 '422': *16 @@ -44165,7 +44211,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 '422': *16 @@ -44225,7 +44271,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 '422': *16 @@ -44261,7 +44307,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '404': *7 x-github: githubCloudOnly: false @@ -44324,7 +44370,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '422': *16 x-github: githubCloudOnly: false @@ -44388,7 +44434,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '422': *16 x-github: githubCloudOnly: false @@ -44451,7 +44497,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '422': *16 x-github: githubCloudOnly: false @@ -49238,7 +49284,7 @@ paths: type: integer codespaces: type: array - items: *155 + items: *156 examples: default: value: @@ -49600,7 +49646,7 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *155 + schema: *156 examples: default: *341 '202': @@ -49608,7 +49654,7 @@ paths: being retried in the background content: application/json: - schema: *155 + schema: *156 examples: default: *341 '400': *15 @@ -51239,10 +51285,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 +51756,7 @@ paths: nullable: true requested_teams: type: array - items: *123 + items: *124 nullable: true head: type: object @@ -54792,18 +54850,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 +54881,8 @@ paths: default: 30 - *41 - *42 - - *131 - *132 + - *133 responses: '200': description: Response @@ -57101,7 +57159,7 @@ paths: reviewer: anyOf: - *19 - - *123 + - *124 required: - id - node_id @@ -60339,7 +60397,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '200': description: Response @@ -60369,7 +60427,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 requestBody: required: true content: @@ -60436,7 +60494,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '204': description: Response @@ -60462,7 +60520,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '200': description: Response @@ -60491,7 +60549,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 requestBody: required: false content: @@ -60537,9 +60595,9 @@ paths: parameters: - *225 - *226 - - *140 - - *18 - *141 + - *18 + - *142 - name: redelivery in: query required: false @@ -60552,9 +60610,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *143 + default: *144 '400': *15 '422': *16 x-github: @@ -60575,16 +60633,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 +60663,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 - *17 responses: '202': *91 @@ -60630,7 +60688,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '204': description: Response @@ -60656,7 +60714,7 @@ paths: parameters: - *225 - *226 - - *140 + - *141 responses: '204': description: Response @@ -61438,7 +61496,7 @@ paths: application/json: schema: anyOf: - - *147 + - *148 - type: object properties: {} additionalProperties: false @@ -61486,7 +61544,7 @@ paths: description: Response content: application/json: - schema: *147 + schema: *148 examples: default: *415 '409': @@ -61680,7 +61738,7 @@ paths: parameters: - *225 - *226 - - *151 + - *152 requestBody: required: false content: @@ -61842,7 +61900,7 @@ paths: parameters: - *225 - *226 - - *151 + - *152 responses: '204': description: Response @@ -61916,7 +61974,7 @@ paths: required: false schema: type: string - - *152 + - *153 - name: sort description: What to sort results by. in: query @@ -62829,7 +62887,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 +64193,7 @@ paths: properties: *53 required: *54 review_requester: *19 - requested_team: *123 + requested_team: *124 requested_reviewer: *19 required: - review_requester @@ -64182,7 +64240,7 @@ paths: properties: *53 required: *54 review_requester: *19 - requested_team: *123 + requested_team: *124 requested_reviewer: *19 required: - review_requester @@ -71059,7 +71117,7 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *155 + schema: *156 examples: default: *341 '202': @@ -71067,7 +71125,7 @@ paths: being retried in the background content: application/json: - schema: *155 + schema: *156 examples: default: *341 '401': *25 @@ -71713,7 +71771,7 @@ paths: items: *19 teams: type: array - items: *123 + items: *124 required: - users - teams @@ -78033,7 +78091,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -78483,7 +78541,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: default: *168 headers: @@ -82361,9 +82419,9 @@ paths: application/json: schema: type: array - items: *149 + items: *150 examples: - default: *150 + default: *151 headers: Link: *50 x-github: @@ -82411,7 +82469,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '404': *7 @@ -83134,7 +83192,7 @@ paths: application/json: schema: type: array - items: *123 + items: *124 examples: response-if-child-teams-exist: *535 headers: @@ -83605,7 +83663,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 '304': *37 '404': *7 '403': *29 @@ -83729,9 +83787,9 @@ paths: type: integer codespaces: type: array - items: *155 + items: *156 examples: - default: *156 + default: *157 '304': *37 '500': *121 '401': *25 @@ -83870,7 +83928,7 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *155 + schema: *156 examples: default: *341 '202': @@ -83878,7 +83936,7 @@ paths: being retried in the background content: application/json: - schema: *155 + schema: *156 examples: default: *341 '401': *25 @@ -84563,13 +84621,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 +84655,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 +84685,7 @@ paths: description: Response content: application/json: - schema: *155 + schema: *156 examples: default: *341 '401': *25 @@ -84651,7 +84709,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 +84738,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 +84817,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 +84853,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 +84900,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 +85729,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 +85769,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 +86162,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '304': *37 @@ -86137,7 +86195,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 '304': *37 @@ -86835,12 +86893,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 +86933,7 @@ paths: description: Response content: application/json: - schema: *147 + schema: *148 examples: default: value: @@ -86958,7 +87016,7 @@ paths: - closed - all default: open - - *152 + - *153 - name: sort description: What to sort results by. in: query @@ -86983,7 +87041,7 @@ paths: type: array items: *69 examples: - default: *153 + default: *154 headers: Link: *50 '404': *7 @@ -88406,7 +88464,7 @@ paths: application/json: schema: type: array - items: *159 + items: *123 examples: default: *553 headers: @@ -89420,7 +89478,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 +89501,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 +90282,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: example: ; rel="next" @@ -90643,7 +90701,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -90674,7 +90732,7 @@ paths: type: array items: *19 examples: - default: *154 + default: *155 headers: Link: *50 x-github: @@ -90946,7 +91004,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 9b44916206..b3d9e17fef 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" ], @@ -231559,7 +231831,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 +231841,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/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 52d78c0377..8ff0ae407b 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 @@ -56912,10 +56958,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: diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index 9b44916206..b3d9e17fef 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" ], @@ -231559,7 +231831,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 +231841,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/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 52d78c0377..8ff0ae407b 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 @@ -56912,10 +56958,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: diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index 1b24921146..39ea8670b1 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" ], @@ -38489,11 +38489,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": { @@ -104288,6 +104295,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 +104372,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 diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index e0008f4aed..8d7f049b44 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 @@ -27886,10 +27885,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: @@ -75871,6 +75882,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 +75939,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 diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json index 1b24921146..39ea8670b1 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" ], @@ -38489,11 +38489,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": { @@ -104288,6 +104295,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 +104372,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 diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index e0008f4aed..8d7f049b44 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 @@ -27886,10 +27885,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: @@ -75871,6 +75882,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 +75939,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 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 9ffacdca5d..1c314db8f1 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 454fd6fb5a..3fc29ea3ed 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 9ffacdca5d..1c314db8f1 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 454fd6fb5a..3fc29ea3ed 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 708fcc5840..8bab0b73f0 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 0d83786db2..15fe57648c 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 708fcc5840..8bab0b73f0 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 0d83786db2..15fe57648c 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 9a96d2ea5b..4b7088a855 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 c999344bda..9f5fb5b469 100644 --- a/descriptions/gh{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}