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 8b8da7346..71df54353 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 @@ -2519,7 +2519,7 @@ "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { "get": { "summary": "Get Copilot metrics for an enterprise team", - "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nUse this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -2609,7 +2609,7 @@ "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for an enterprise team", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -11599,7 +11599,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\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 \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\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" ], @@ -11699,7 +11699,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\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" ], @@ -11801,7 +11801,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\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 \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\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" ], @@ -11901,7 +11901,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\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" ], @@ -120471,18 +120471,19 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active", + "description": "The time that the scan was completed. Empty if the scan is running", "nullable": true }, "started_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending", + "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 338c57243..013af1d88 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 @@ -1761,6 +1761,9 @@ paths: get: summary: Get Copilot metrics for an enterprise team description: |- + > [!NOTE] + > This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, @@ -1837,7 +1840,7 @@ paths: summary: Get a summary of Copilot usage for an enterprise team description: |- > [!NOTE] - > This endpoint is in public preview and is subject to change. + > This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -8476,13 +8479,11 @@ paths: Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-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. + Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." - The response will contain the total number of new seats that were created and existing seats that were refreshed. + The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -8560,14 +8561,11 @@ paths: Sets seats for all members of each team specified to "pending cancellation". This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - - For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. - The response will contain the total number of seats set to "pending cancellation". + The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -8647,13 +8645,11 @@ paths: Purchases a GitHub Copilot seat for each user specified. The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-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. + Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." - The response will contain the total number of new seats that were created and existing seats that were refreshed. + The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -8730,14 +8726,11 @@ paths: Sets seats for all users specified to "pending cancellation". This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - - For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. - The response will contain the total number of seats set to "pending cancellation". + The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -88772,17 +88765,18 @@ components: description: The type of scan status: type: string - description: The state of the scan. Either "completed" or "running" + description: The state of the scan. Either "completed", "running", or "pending" completed_at: type: string format: date-time description: The time that the scan was completed. Empty if the scan is - active + running nullable: true started_at: type: string format: date-time - description: The time that the scan was started + description: The time that the scan was started. Empty if the scan is pending + nullable: true secret-scanning-scan-history: type: object properties: diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 8b8da7346..71df54353 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -2519,7 +2519,7 @@ "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { "get": { "summary": "Get Copilot metrics for an enterprise team", - "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nUse this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -2609,7 +2609,7 @@ "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for an enterprise team", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -11599,7 +11599,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\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 \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\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" ], @@ -11699,7 +11699,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\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" ], @@ -11801,7 +11801,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\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 \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\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" ], @@ -11901,7 +11901,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\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" ], @@ -120471,18 +120471,19 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active", + "description": "The time that the scan was completed. Empty if the scan is running", "nullable": true }, "started_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true } } }, diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 338c57243..013af1d88 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -1761,6 +1761,9 @@ paths: get: summary: Get Copilot metrics for an enterprise team description: |- + > [!NOTE] + > This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, @@ -1837,7 +1840,7 @@ paths: summary: Get a summary of Copilot usage for an enterprise team description: |- > [!NOTE] - > This endpoint is in public preview and is subject to change. + > This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -8476,13 +8479,11 @@ paths: Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-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. + Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." - The response will contain the total number of new seats that were created and existing seats that were refreshed. + The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -8560,14 +8561,11 @@ paths: Sets seats for all members of each team specified to "pending cancellation". This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - - For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. - The response will contain the total number of seats set to "pending cancellation". + The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -8647,13 +8645,11 @@ paths: Purchases a GitHub Copilot seat for each user specified. The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-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. + Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." - The response will contain the total number of new seats that were created and existing seats that were refreshed. + The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -8730,14 +8726,11 @@ paths: Sets seats for all users specified to "pending cancellation". This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - - For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. - The response will contain the total number of seats set to "pending cancellation". + The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -88772,17 +88765,18 @@ components: description: The type of scan status: type: string - description: The state of the scan. Either "completed" or "running" + description: The state of the scan. Either "completed", "running", or "pending" completed_at: type: string format: date-time description: The time that the scan was completed. Empty if the scan is - active + running nullable: true started_at: type: string format: date-time - description: The time that the scan was started + description: The time that the scan was started. Empty if the scan is pending + nullable: true secret-scanning-scan-history: type: object properties: 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 97d07f585..021b6a0f2 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 @@ -20752,7 +20752,7 @@ "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { "get": { "summary": "Get Copilot metrics for an enterprise team", - "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nUse this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -21401,7 +21401,7 @@ "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for an enterprise team", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -71030,7 +71030,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\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 \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\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" ], @@ -71228,7 +71228,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\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" ], @@ -71428,7 +71428,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\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 \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\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" ], @@ -71626,7 +71626,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\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" ], @@ -401744,18 +401744,19 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active", + "description": "The time that the scan was completed. Empty if the scan is running", "nullable": true }, "started_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true } } } @@ -401772,18 +401773,19 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active", + "description": "The time that the scan was completed. Empty if the scan is running", "nullable": true }, "started_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true } } } @@ -401800,18 +401802,19 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active", + "description": "The time that the scan was completed. Empty if the scan is running", "nullable": true }, "started_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true } } } @@ -401830,18 +401833,19 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active", + "description": "The time that the scan was completed. Empty if the scan is running", "nullable": true }, "started_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true } } }, 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 7f7fa309a..39eceaa09 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 @@ -9557,6 +9557,9 @@ paths: get: summary: Get Copilot metrics for an enterprise team description: |- + > [!NOTE] + > This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, @@ -9632,7 +9635,7 @@ paths: summary: Get a summary of Copilot usage for an enterprise team description: |- > [!NOTE] - > This endpoint is in public preview and is subject to change. + > This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -22965,13 +22968,11 @@ paths: Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-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. + Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." - The response will contain the total number of new seats that were created and existing seats that were refreshed. + The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -23045,14 +23046,11 @@ paths: Sets seats for all members of each team specified to "pending cancellation". This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - - For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. - The response will contain the total number of seats set to "pending cancellation". + The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -23128,13 +23126,11 @@ paths: Purchases a GitHub Copilot seat for each user specified. The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-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. + Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." - The response will contain the total number of new seats that were created and existing seats that were refreshed. + The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -23207,14 +23203,11 @@ paths: Sets seats for all users specified to "pending cancellation". This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - - For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. - The response will contain the total number of seats set to "pending cancellation". + The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -80639,18 +80632,20 @@ paths: description: The type of scan status: type: string - description: The state of the scan. Either "completed" or - "running" + description: The state of the scan. Either "completed", + "running", or "pending" completed_at: type: string format: date-time description: The time that the scan was completed. Empty - if the scan is active + if the scan is running nullable: true started_at: type: string format: date-time - description: The time that the scan was started + description: The time that the scan was started. Empty if + the scan is pending + nullable: true pattern_update_scans: type: array items: *547 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 97d07f585..021b6a0f2 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -20752,7 +20752,7 @@ "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { "get": { "summary": "Get Copilot metrics for an enterprise team", - "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nUse this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -21401,7 +21401,7 @@ "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for an enterprise team", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -71030,7 +71030,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\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 \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\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" ], @@ -71228,7 +71228,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\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" ], @@ -71428,7 +71428,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\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 \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\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" ], @@ -71626,7 +71626,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\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" ], @@ -401744,18 +401744,19 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active", + "description": "The time that the scan was completed. Empty if the scan is running", "nullable": true }, "started_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true } } } @@ -401772,18 +401773,19 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active", + "description": "The time that the scan was completed. Empty if the scan is running", "nullable": true }, "started_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true } } } @@ -401800,18 +401802,19 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active", + "description": "The time that the scan was completed. Empty if the scan is running", "nullable": true }, "started_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true } } } @@ -401830,18 +401833,19 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active", + "description": "The time that the scan was completed. Empty if the scan is running", "nullable": true }, "started_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true } } }, 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 7f7fa309a..39eceaa09 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -9557,6 +9557,9 @@ paths: get: summary: Get Copilot metrics for an enterprise team description: |- + > [!NOTE] + > This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, @@ -9632,7 +9635,7 @@ paths: summary: Get a summary of Copilot usage for an enterprise team description: |- > [!NOTE] - > This endpoint is in public preview and is subject to change. + > This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -22965,13 +22968,11 @@ paths: Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-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. + Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." - The response will contain the total number of new seats that were created and existing seats that were refreshed. + The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -23045,14 +23046,11 @@ paths: Sets seats for all members of each team specified to "pending cancellation". This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - - For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. - The response will contain the total number of seats set to "pending cancellation". + The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -23128,13 +23126,11 @@ paths: Purchases a GitHub Copilot seat for each user specified. The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-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. + Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." - The response will contain the total number of new seats that were created and existing seats that were refreshed. + The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -23207,14 +23203,11 @@ paths: Sets seats for all users specified to "pending cancellation". This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - - For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. - The response will contain the total number of seats set to "pending cancellation". + The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -80639,18 +80632,20 @@ paths: description: The type of scan status: type: string - description: The state of the scan. Either "completed" or - "running" + description: The state of the scan. Either "completed", + "running", or "pending" completed_at: type: string format: date-time description: The time that the scan was completed. Empty - if the scan is active + if the scan is running nullable: true started_at: type: string format: date-time - description: The time that the scan was started + description: The time that the scan was started. Empty if + the scan is pending + nullable: true pattern_update_scans: type: array items: *547 diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index cef2aedaf..89e1db9ad 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -29009,6 +29009,1059 @@ } } }, + "/enterprises/{enterprise}/properties/schema": { + "get": { + "summary": "Get custom properties for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets all custom properties defined for an enterprise.\nEnterprise members can read these properties.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/get-enterprise-custom-properties", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-custom-properties-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + }, + "patch": { + "summary": "Create or update custom properties for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates new or updates existing custom properties defined for an enterprise in a batch.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/create-or-update-enterprise-custom-properties", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-custom-properties-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "The array of custom properties to create or update.", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "minItems": 1, + "maxItems": 100 + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + } + }, + "/enterprises/{enterprise}/properties/schema/{custom_property_name}": { + "get": { + "summary": "Get a custom property for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a custom property that is defined for an enterprise.\nEnterprise members can read these properties.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/get-enterprise-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + }, + "put": { + "summary": "Create or update a custom property for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new or updates an existing custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/create-or-update-enterprise-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + }, + "delete": { + "summary": "Remove a custom property for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemove a custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/remove-enterprise-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "A header with no content is returned." + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + } + }, "/enterprises/{enterprise}/secret-scanning/alerts": { "get": { "summary": "List secret scanning alerts for an enterprise", @@ -31864,7 +32917,7 @@ "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { "get": { "summary": "Get Copilot metrics for an enterprise team", - "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nUse this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -32513,7 +33566,7 @@ "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for an enterprise team", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -83152,7 +84205,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\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 \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\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" ], @@ -83350,7 +84403,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\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" ], @@ -83550,7 +84603,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\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 \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\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" ], @@ -83748,7 +84801,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\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" ], @@ -419881,18 +420934,19 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active", + "description": "The time that the scan was completed. Empty if the scan is running", "nullable": true }, "started_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true } } } @@ -419909,18 +420963,19 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active", + "description": "The time that the scan was completed. Empty if the scan is running", "nullable": true }, "started_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true } } } @@ -419937,18 +420992,19 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active", + "description": "The time that the scan was completed. Empty if the scan is running", "nullable": true }, "started_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true } } } @@ -419967,18 +421023,19 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active", + "description": "The time that the scan was completed. Empty if the scan is running", "nullable": true }, "started_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true } } }, diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 5278c1989..5aeced821 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -979,7 +979,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &145 + schema: &149 title: Validation Error Simple description: Validation Error Simple type: object @@ -1130,7 +1130,7 @@ paths: GitHub. type: object nullable: true - properties: &103 + properties: &107 id: description: Unique identifier of the GitHub app example: 37 @@ -1219,7 +1219,7 @@ paths: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' - required: &104 + required: &108 - id - node_id - owner @@ -1524,7 +1524,7 @@ paths: schema: type: integer default: 30 - - &216 + - &220 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 @@ -1540,7 +1540,7 @@ paths: application/json: schema: type: array - items: &217 + items: &221 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1617,7 +1617,7 @@ paths: - installation_id - repository_id examples: - default: &218 + default: &222 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1676,7 +1676,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &144 + schema: &148 title: Validation Error description: Validation Error type: object @@ -1745,7 +1745,7 @@ paths: description: Response content: application/json: - schema: &219 + schema: &223 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1859,7 +1859,7 @@ paths: - request - response examples: - default: &220 + default: &224 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1919,7 +1919,7 @@ paths: parameters: - *17 responses: - '202': &147 + '202': &151 description: Accepted content: application/json: @@ -2114,7 +2114,7 @@ paths: parameters: - *18 - *20 - - &108 + - &112 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) @@ -2860,7 +2860,7 @@ paths: title: License Simple description: License Simple type: object - properties: &119 + properties: &123 key: type: string example: mit @@ -2882,7 +2882,7 @@ paths: html_url: type: string format: uri - required: &120 + required: &124 - key - name - url @@ -7282,7 +7282,7 @@ paths: description: Response content: application/json: - schema: &148 + schema: &152 type: object properties: total_active_caches_count: @@ -7297,7 +7297,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &149 + default: &153 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7391,7 +7391,7 @@ paths: - all - local_only - selected - selected_actions_url: &152 + selected_actions_url: &156 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` @@ -7759,7 +7759,7 @@ paths: description: Success response content: application/json: - schema: &155 + schema: &159 type: object properties: default_workflow_permissions: &46 @@ -7807,7 +7807,7 @@ paths: required: true content: application/json: - schema: &156 + schema: &160 type: object properties: default_workflow_permissions: *46 @@ -8628,7 +8628,7 @@ paths: application/json: schema: type: array - items: &160 + items: &164 title: Runner Application description: Runner Application type: object @@ -8653,7 +8653,7 @@ paths: - download_url - filename examples: - default: &161 + default: &165 value: - os: osx architecture: x64 @@ -8737,7 +8737,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &162 + '201': &166 description: Response content: application/json: @@ -8847,7 +8847,7 @@ paths: - token - expires_at examples: - default: &163 + default: &167 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -8887,7 +8887,7 @@ paths: application/json: schema: *58 examples: - default: &164 + default: &168 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -8919,7 +8919,7 @@ paths: application/json: schema: *55 examples: - default: &165 + default: &169 value: id: 23 name: MBP @@ -9133,7 +9133,7 @@ paths: - *40 - *54 responses: - '200': &166 + '200': &170 description: Response content: application/json: @@ -9189,7 +9189,7 @@ paths: parameters: - *40 - *54 - - &167 + - &171 name: name description: The name of a self-hosted runner's custom label. in: path @@ -9280,7 +9280,7 @@ paths: required: true content: application/json: - schema: &174 + schema: &178 title: Enterprise Announcement description: Enterprise global announcement type: object @@ -9351,7 +9351,7 @@ paths: required: false schema: type: string - - &175 + - &179 name: include description: |- The event types to include: @@ -9369,7 +9369,7 @@ paths: - web - git - all - - &176 + - &180 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. @@ -9377,7 +9377,7 @@ paths: required: false schema: type: string - - &177 + - &181 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. @@ -9385,7 +9385,7 @@ paths: required: false schema: type: string - - &178 + - &182 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -9407,7 +9407,7 @@ paths: application/json: schema: type: array - items: &179 + items: &183 type: object properties: "@timestamp": @@ -9529,7 +9529,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &180 + default: &184 value: - "@timestamp": 1606929874512 action: team.add_member @@ -10091,7 +10091,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *40 - - &182 + - &186 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, @@ -10101,7 +10101,7 @@ paths: schema: &79 type: string description: The name of the tool used to generate the code scanning analysis. - - &183 + - &187 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -10124,7 +10124,7 @@ paths: be returned. in: query required: false - schema: &184 + schema: &188 type: string description: State of a code scanning alert. enum: @@ -10149,7 +10149,7 @@ paths: application/json: schema: type: array - items: &185 + items: &189 type: object properties: number: &85 @@ -10648,7 +10648,7 @@ paths: - most_recent_instance - repository examples: - default: &186 + default: &190 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -10879,7 +10879,7 @@ paths: headers: Link: *39 '404': *7 - '503': &96 + '503': &100 description: Service unavailable content: application/json: @@ -11288,7 +11288,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &192 + items: &196 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -11306,7 +11306,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &238 + - &242 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -11365,7 +11365,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &251 + properties: &255 id: description: Unique identifier of the team type: integer @@ -11421,7 +11421,7 @@ paths: maps to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string - required: &252 + required: &256 - id - node_id - url @@ -11532,7 +11532,7 @@ paths: - created_at additionalProperties: false examples: - default: &193 + default: &197 value: total_seats: 2 seats: @@ -11667,7 +11667,7 @@ paths: application/json: schema: type: array - items: &98 + items: &102 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -11975,7 +11975,7 @@ paths: - date additionalProperties: true examples: - default: &99 + default: &103 value: - date: '2024-06-24' total_active_users: 24 @@ -12077,7 +12077,7 @@ paths: '500': *84 '403': *29 '404': *7 - '422': &100 + '422': &104 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -12147,7 +12147,7 @@ paths: application/json: schema: type: array - items: &101 + items: &105 title: Copilot Usage Metrics description: Summary of Copilot usage. type: object @@ -12326,7 +12326,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &200 + - &204 name: state in: query description: |- @@ -12335,7 +12335,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &201 + - &205 name: severity in: query description: |- @@ -12344,7 +12344,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &202 + - &206 name: ecosystem in: query description: |- @@ -12353,14 +12353,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &203 + - &207 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 - - &204 + - &208 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -12370,7 +12370,7 @@ paths: enum: - development - runtime - - &205 + - &209 name: sort in: query description: |- @@ -12386,7 +12386,7 @@ paths: - *78 - *76 - *77 - - &206 + - &210 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -12399,7 +12399,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &207 + - &211 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -12419,7 +12419,7 @@ paths: application/json: schema: type: array - items: &208 + items: &212 type: object description: A Dependabot alert. properties: @@ -12726,7 +12726,7 @@ paths: - repository additionalProperties: false examples: - default: &209 + default: &213 value: - number: 2 state: dismissed @@ -13118,6 +13118,303 @@ paths: previews: [] category: enterprise-admin subcategory: license + "/enterprises/{enterprise}/properties/schema": + get: + summary: Get custom properties for an enterprise + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets all custom properties defined for an enterprise. + Enterprise members can read these properties. + tags: + - enterprise-admin + operationId: enterprise-admin/get-enterprise-custom-properties + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-custom-properties-for-an-enterprise + parameters: + - *40 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: &96 + title: Organization Custom Property + description: Custom property defined on an organization + type: object + properties: + property_name: + type: string + description: The name of the property + url: + type: string + format: uri + description: The URL that can be used to fetch, update, or delete + info about this property via the API. + source_type: + type: string + description: The source type of the property + enum: + - organization + - enterprise + example: organization + value_type: + type: string + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + nullable: true + description: Default value of the property + description: + type: string + nullable: true + description: Short description of the property + allowed_values: + type: array + items: + type: string + maxLength: 75 + maxItems: 200 + nullable: true + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + values_editable_by: + type: string + nullable: true + enum: + - org_actors + - org_and_repo_actors + example: org_actors + description: Who can edit the values of the property + required: + - property_name + - value_type + examples: + default: &97 + value: + - property_name: environment + url: https://api.github.com/orgs/github/properties/schema/environment + source_type: organization + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + values_editable_by: org_actors + - property_name: service + url: https://api.github.com/orgs/github/properties/schema/service + source_type: organization + value_type: string + - property_name: team + url: https://api.github.com/orgs/github/properties/schema/team + source_type: organization + value_type: string + description: Team owning the repository + '403': *29 + '404': *7 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties + patch: + summary: Create or update custom properties for an enterprise + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Creates new or updates existing custom properties defined for an enterprise in a batch. + + To use this endpoint, the authenticated user must be an administrator for the enterprise. + tags: + - enterprise-admin + operationId: enterprise-admin/create-or-update-enterprise-custom-properties + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-custom-properties-for-an-enterprise + parameters: + - *40 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: The array of custom properties to create or update. + items: *96 + minItems: 1 + maxItems: 100 + required: + - properties + examples: + default: + value: + properties: + - property_name: environment + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + values_editable_by: org_actors + - property_name: service + value_type: string + - property_name: team + value_type: string + description: Team owning the repository + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *96 + examples: + default: *97 + '403': *29 + '404': *7 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties + "/enterprises/{enterprise}/properties/schema/{custom_property_name}": + get: + summary: Get a custom property for an enterprise + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets a custom property that is defined for an enterprise. + Enterprise members can read these properties. + tags: + - enterprise-admin + operationId: enterprise-admin/get-enterprise-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise + parameters: + - *40 + - &98 + name: custom_property_name + description: The custom property name + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: *96 + examples: + default: &99 + value: + property_name: environment + url: https://api.github.com/orgs/github/properties/schema/environment + source_type: organization + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + '403': *29 + '404': *7 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties + put: + summary: Create or update a custom property for an enterprise + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Creates a new or updates an existing custom property that is defined for an enterprise. + + To use this endpoint, the authenticated user must be an administrator for the enterprise. + tags: + - enterprise-admin + operationId: enterprise-admin/create-or-update-enterprise-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise + parameters: + - *40 + - *98 + responses: + '200': + description: Response + content: + application/json: + schema: *96 + examples: + default: *99 + '403': *29 + '404': *7 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties + delete: + summary: Remove a custom property for an enterprise + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Remove a custom property that is defined for an enterprise. + + To use this endpoint, the authenticated user must be an administrator for the enterprise. + tags: + - enterprise-admin + operationId: enterprise-admin/remove-enterprise-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise + parameters: + - *40 + - *98 + responses: + '204': &192 + description: A header with no content is returned. + '403': *29 + '404': *7 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties "/enterprises/{enterprise}/secret-scanning/alerts": get: summary: List secret scanning alerts for an enterprise @@ -13563,7 +13860,7 @@ paths: headers: Link: *39 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -13842,7 +14139,7 @@ paths: '400': *15 '403': *29 '500': *84 - '503': *96 + '503': *100 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -13863,7 +14160,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#add-users-to-a-cost-center parameters: - *40 - - &97 + - &101 name: cost_center_id description: The ID corresponding to the cost center. in: path @@ -13905,13 +14202,13 @@ paths: message: Resources successfully added to the cost center. '400': *15 '403': *29 - '409': &146 + '409': &150 description: Conflict content: application/json: schema: *3 '500': *84 - '503': *96 + '503': *100 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -13931,7 +14228,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#remove-users-from-a-cost-center parameters: - *40 - - *97 + - *101 requestBody: required: true content: @@ -13969,7 +14266,7 @@ paths: '400': *15 '403': *29 '500': *84 - '503': *96 + '503': *100 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -14090,7 +14387,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise parameters: - *40 - - &135 + - &139 name: year description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, @@ -14099,7 +14396,7 @@ paths: required: false schema: type: integer - - &136 + - &140 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. @@ -14107,7 +14404,7 @@ paths: required: false schema: type: integer - - &137 + - &141 name: day description: If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. @@ -14115,7 +14412,7 @@ paths: required: false schema: type: integer - - &138 + - &142 name: hour description: If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. @@ -14135,7 +14432,7 @@ paths: description: Response when getting a billing usage report content: application/json: - schema: &139 + schema: &143 type: object properties: usageItems: @@ -14188,7 +14485,7 @@ paths: - netAmount - organizationName examples: - default: &140 + default: &144 value: usageItems: - date: '2023-08-01' @@ -14205,7 +14502,7 @@ paths: '400': *15 '403': *29 '500': *84 - '503': *96 + '503': *100 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -14215,6 +14512,9 @@ paths: get: summary: Get Copilot metrics for an enterprise team description: |- + > [!NOTE] + > This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, @@ -14273,13 +14573,13 @@ paths: application/json: schema: type: array - items: *98 + items: *102 examples: - default: *99 + default: *103 '500': *84 '403': *29 '404': *7 - '422': *100 + '422': *104 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14290,7 +14590,7 @@ paths: summary: Get a summary of Copilot usage for an enterprise team description: |- > [!NOTE] - > This endpoint is in public preview and is subject to change. + > This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -14314,7 +14614,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team parameters: - *40 - - &250 + - &254 name: team_slug description: The slug of the team name. in: path @@ -14352,9 +14652,9 @@ paths: application/json: schema: type: array - items: *101 + items: *105 examples: - default: &194 + default: &198 value: - day: '2023-10-15' total_suggestions_count: 1000 @@ -14510,7 +14810,7 @@ paths: application/json: schema: type: array - items: &130 + items: &134 title: Event description: Event type: object @@ -14520,7 +14820,7 @@ paths: type: type: string nullable: true - actor: &102 + actor: &106 title: Actor description: Actor type: object @@ -14560,13 +14860,13 @@ paths: - id - name - url - org: *102 + org: *106 payload: type: object properties: action: type: string - issue: &118 + issue: &122 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -14841,9 +15141,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 - author_association: &105 + properties: *107 + required: *108 + author_association: &109 title: author_association type: string example: OWNER @@ -14857,7 +15157,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &106 + reactions: &110 title: Reaction Rollup type: object properties: @@ -14977,7 +15277,7 @@ paths: issue_url: type: string format: uri - author_association: *105 + author_association: *109 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -14987,9 +15287,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 - reactions: *106 + properties: *107 + required: *108 + reactions: *110 required: - id - node_id @@ -15084,7 +15384,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15165,7 +15465,7 @@ paths: _links: type: object properties: - timeline: &107 + timeline: &111 title: Link With Type description: Hypermedia Link with Type type: object @@ -15177,17 +15477,17 @@ paths: required: - href - type - user: *107 - security_advisories: *107 - current_user: *107 - current_user_public: *107 - current_user_actor: *107 - current_user_organization: *107 + user: *111 + security_advisories: *111 + current_user: *111 + current_user_public: *111 + current_user_actor: *111 + current_user_organization: *111 current_user_organizations: type: array - items: *107 - repository_discussions: *107 - repository_discussions_category: *107 + items: *111 + repository_discussions: *111 + repository_discussions_category: *111 required: - timeline - user @@ -15249,7 +15549,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *108 + - *112 - *18 - *20 responses: @@ -15259,7 +15559,7 @@ paths: application/json: schema: type: array - items: &109 + items: &113 title: Base Gist description: Base Gist type: object @@ -15356,7 +15656,7 @@ paths: - created_at - updated_at examples: - default: &110 + default: &114 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -15477,7 +15777,7 @@ paths: description: Response content: application/json: - schema: &111 + schema: &115 title: Gist Simple description: Gist Simple type: object @@ -15852,7 +16152,7 @@ paths: truncated: type: boolean examples: - default: &112 + default: &116 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -15955,7 +16255,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *108 + - *112 - *18 - *20 responses: @@ -15965,9 +16265,9 @@ paths: application/json: schema: type: array - items: *109 + items: *113 examples: - default: *110 + default: *114 headers: Link: *39 '422': *16 @@ -15989,7 +16289,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *108 + - *112 - *18 - *20 responses: @@ -15999,9 +16299,9 @@ paths: application/json: schema: type: array - items: *109 + items: *113 examples: - default: *110 + default: *114 headers: Link: *39 '401': *25 @@ -16029,7 +16329,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &113 + - &117 name: gist_id description: The unique identifier of the gist. in: path @@ -16041,10 +16341,10 @@ paths: description: Response content: application/json: - schema: *111 + schema: *115 examples: - default: *112 - '403': &116 + default: *116 + '403': &120 description: Forbidden Gist content: application/json: @@ -16092,7 +16392,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *113 + - *117 requestBody: required: true content: @@ -16152,9 +16452,9 @@ paths: description: Response content: application/json: - schema: *111 + schema: *115 examples: - updateGist: *112 + updateGist: *116 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -16312,7 +16612,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *113 + - *117 responses: '204': description: Response @@ -16341,7 +16641,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *113 + - *117 - *18 - *20 responses: @@ -16351,7 +16651,7 @@ paths: application/json: schema: type: array - items: &114 + items: &118 title: Gist Comment description: A comment made to a gist. type: object @@ -16386,7 +16686,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *105 + author_association: *109 required: - url - id @@ -16451,7 +16751,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *113 + - *117 requestBody: required: true content: @@ -16476,9 +16776,9 @@ paths: description: Response content: application/json: - schema: *114 + schema: *118 examples: - default: &115 + default: &119 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -16536,8 +16836,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *113 - - &117 + - *117 + - &121 name: comment_id description: The unique identifier of the comment. in: path @@ -16550,12 +16850,12 @@ paths: description: Response content: application/json: - schema: *114 + schema: *118 examples: - default: *115 + default: *119 '304': *37 '404': *7 - '403': *116 + '403': *120 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -16577,8 +16877,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *113 - *117 + - *121 requestBody: required: true content: @@ -16603,9 +16903,9 @@ paths: description: Response content: application/json: - schema: *114 + schema: *118 examples: - default: *115 + default: *119 '404': *7 x-github: githubCloudOnly: false @@ -16622,8 +16922,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *113 - *117 + - *121 responses: '204': description: Response @@ -16646,7 +16946,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *113 + - *117 - *18 - *20 responses: @@ -16747,7 +17047,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *113 + - *117 - *18 - *20 responses: @@ -16757,7 +17057,7 @@ paths: application/json: schema: type: array - items: *111 + items: *115 examples: default: value: @@ -16822,13 +17122,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *113 + - *117 responses: '201': description: Response content: application/json: - schema: *109 + schema: *113 examples: default: value: @@ -16899,7 +17199,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *113 + - *117 responses: '204': description: Response if gist is starred @@ -16929,7 +17229,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *113 + - *117 responses: '204': description: Response @@ -16951,7 +17251,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *113 + - *117 responses: '204': description: Response @@ -16980,7 +17280,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *113 + - *117 - name: sha in: path required: true @@ -16991,9 +17291,9 @@ paths: description: Response content: application/json: - schema: *111 + schema: *115 examples: - default: *112 + default: *116 '422': *16 '404': *7 '403': *29 @@ -17359,7 +17659,7 @@ paths: - closed - all default: open - - &239 + - &243 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -17378,7 +17678,7 @@ paths: - comments default: created - *78 - - *108 + - *112 - name: collab in: query required: false @@ -17408,9 +17708,9 @@ paths: application/json: schema: type: array - items: *118 + items: *122 examples: - default: &240 + default: &244 value: - id: 1 node_id: MDU6SXNzdWUx @@ -17694,8 +17994,8 @@ paths: title: License Simple description: License Simple type: object - properties: *119 - required: *120 + properties: *123 + required: *124 examples: default: value: @@ -17979,7 +18279,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &121 + X-CommonMarker-Version: &125 example: 0.17.4 schema: type: string @@ -18034,7 +18334,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *121 + X-CommonMarker-Version: *125 content: text/html: schema: @@ -18063,7 +18363,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &124 + - &128 name: account_id description: account_id parameter in: path @@ -18075,7 +18375,7 @@ paths: description: Response content: application/json: - schema: &123 + schema: &127 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -18105,7 +18405,7 @@ paths: nullable: true id: type: integer - plan: &122 + plan: &126 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -18194,7 +18494,7 @@ paths: nullable: true updated_at: type: string - plan: *122 + plan: *126 required: - url - id @@ -18202,7 +18502,7 @@ paths: - login - marketplace_purchase examples: - default: &125 + default: &129 value: url: https://api.github.com/orgs/github type: Organization @@ -18287,9 +18587,9 @@ paths: application/json: schema: type: array - items: *122 + items: *126 examples: - default: &126 + default: &130 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -18329,14 +18629,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &127 + - &131 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &128 + - &132 name: sort description: The property to sort the results by. in: query @@ -18366,9 +18666,9 @@ paths: application/json: schema: type: array - items: *123 + items: *127 examples: - default: &129 + default: &133 value: - url: https://api.github.com/orgs/github type: Organization @@ -18442,15 +18742,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *124 + - *128 responses: '200': description: Response content: application/json: - schema: *123 + schema: *127 examples: - default: *125 + default: *129 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -18482,9 +18782,9 @@ paths: application/json: schema: type: array - items: *122 + items: *126 examples: - default: *126 + default: *130 headers: Link: *39 '401': *25 @@ -18507,8 +18807,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *127 - - *128 + - *131 + - *132 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -18528,9 +18828,9 @@ paths: application/json: schema: type: array - items: *123 + items: *127 examples: - default: *129 + default: *133 headers: Link: *39 '401': *25 @@ -18803,7 +19103,7 @@ paths: application/json: schema: type: array - items: *130 + items: *134 examples: default: value: @@ -18896,7 +19196,7 @@ paths: schema: type: boolean default: false - - *108 + - *112 - &540 name: before description: 'Only show notifications updated before the given time. This @@ -18922,18 +19222,18 @@ paths: application/json: schema: type: array - items: &131 + items: &135 title: Thread description: Thread type: object properties: id: type: string - repository: &159 + repository: &163 title: Minimal Repository description: Minimal Repository type: object - properties: &211 + properties: &215 id: type: integer format: int64 @@ -19273,7 +19573,7 @@ paths: enum: - enabled - disabled - required: &212 + required: &216 - archive_url - assignees_url - blobs_url @@ -19527,7 +19827,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &132 + - &136 name: thread_id description: The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications @@ -19541,7 +19841,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *135 examples: default: value: @@ -19644,7 +19944,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *132 + - *136 responses: '205': description: Reset Content @@ -19667,7 +19967,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *132 + - *136 responses: '204': description: No content @@ -19690,13 +19990,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *132 + - *136 responses: '200': description: Response content: application/json: - schema: &133 + schema: &137 title: Thread Subscription description: Thread Subscription type: object @@ -19733,7 +20033,7 @@ paths: - url - subscribed examples: - default: &134 + default: &138 value: subscribed: true ignored: false @@ -19764,7 +20064,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *132 + - *136 requestBody: required: false content: @@ -19785,9 +20085,9 @@ paths: description: Response content: application/json: - schema: *133 + schema: *137 examples: - default: *134 + default: *138 '304': *37 '403': *29 '401': *25 @@ -19810,7 +20110,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *132 + - *136 responses: '204': description: Response @@ -19971,7 +20271,7 @@ paths: type: integer custom_roles: type: array - items: &195 + items: &199 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -20019,7 +20319,7 @@ paths: - created_at - updated_at examples: - default: &196 + default: &200 value: id: 8030 name: Security Engineer @@ -20065,29 +20365,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - - &141 + - &145 name: org description: The organization name. The name is not case sensitive. in: path required: true schema: type: string - - *135 - - *136 - - *137 - - *138 + - *139 + - *140 + - *141 + - *142 responses: '200': description: Billing usage report response for an organization content: application/json: - schema: *139 + schema: *143 examples: - default: *140 + default: *144 '400': *15 '403': *29 '500': *84 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20113,13 +20413,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization parameters: - - *141 + - *145 responses: '200': description: Response content: application/json: - schema: &142 + schema: &146 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -20422,7 +20722,7 @@ paths: - updated_at - archived_at examples: - default-response: &143 + default-response: &147 value: login: github id: 1 @@ -20515,7 +20815,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization parameters: - - *141 + - *145 requestBody: required: false content: @@ -20738,18 +21038,18 @@ paths: description: Response content: application/json: - schema: *142 + schema: *146 examples: - default: *143 + default: *147 '422': description: Validation failed content: application/json: schema: oneOf: - - *144 - - *145 - '409': *146 + - *148 + - *149 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20772,9 +21072,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization parameters: - - *141 + - *145 responses: - '202': *147 + '202': *151 '404': *7 '403': *29 x-github: @@ -20797,15 +21097,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response content: application/json: - schema: *148 + schema: *152 examples: - default: *149 + default: *153 headers: Link: *39 x-github: @@ -20828,7 +21128,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - - *141 + - *145 - *18 - *20 responses: @@ -20901,13 +21201,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *141 + - *145 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &150 + schema: &154 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -20921,7 +21221,7 @@ paths: required: - include_claim_keys examples: - default: &151 + default: &155 value: include_claim_keys: - repo @@ -20943,20 +21243,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *141 + - *145 requestBody: required: true content: application/json: - schema: *150 + schema: *154 examples: - default: *151 + default: *155 responses: '201': description: Empty response content: application/json: - schema: &170 + schema: &174 title: Empty Object description: An object without any properties. type: object @@ -20986,7 +21286,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -20995,7 +21295,7 @@ paths: schema: type: object properties: - enabled_repositories: &153 + enabled_repositories: &157 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -21009,7 +21309,7 @@ paths: that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: *42 - selected_actions_url: *152 + selected_actions_url: *156 required: - enabled_repositories examples: @@ -21038,7 +21338,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *141 + - *145 responses: '204': description: Response @@ -21049,7 +21349,7 @@ paths: schema: type: object properties: - enabled_repositories: *153 + enabled_repositories: *157 allowed_actions: *42 required: - enabled_repositories @@ -21077,7 +21377,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *141 + - *145 - *18 - *20 responses: @@ -21237,7 +21537,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *141 + - *145 responses: '204': description: Response @@ -21281,8 +21581,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *141 - - &154 + - *145 + - &158 name: repository_id description: The unique identifier of the repository. in: path @@ -21310,8 +21610,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *141 - - *154 + - *145 + - *158 responses: '204': description: Response @@ -21334,7 +21634,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -21365,7 +21665,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *141 + - *145 responses: '204': description: Response @@ -21397,13 +21697,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response content: application/json: - schema: *155 + schema: *159 examples: default: *48 x-github: @@ -21426,7 +21726,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *141 + - *145 responses: '204': description: Success response @@ -21437,7 +21737,7 @@ paths: required: false content: application/json: - schema: *156 + schema: *160 examples: default: *48 x-github: @@ -21459,7 +21759,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - - *141 + - *145 - *18 - *20 - name: visible_to_repository @@ -21484,7 +21784,7 @@ paths: type: number runner_groups: type: array - items: &157 + items: &161 type: object properties: id: @@ -21596,7 +21896,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - - *141 + - *145 requestBody: required: true content: @@ -21665,9 +21965,9 @@ paths: description: Response content: application/json: - schema: *157 + schema: *161 examples: - default: &158 + default: &162 value: id: 2 name: octo-runner-group @@ -21702,14 +22002,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - - *141 + - *145 - *51 responses: '200': description: Response content: application/json: - schema: *157 + schema: *161 examples: default: value: @@ -21745,7 +22045,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - - *141 + - *145 - *51 requestBody: required: true @@ -21796,9 +22096,9 @@ paths: description: Response content: application/json: - schema: *157 + schema: *161 examples: - default: *158 + default: *162 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21817,7 +22117,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - - *141 + - *145 - *51 responses: '204': @@ -21841,7 +22141,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *141 + - *145 - *51 - *20 - *18 @@ -21860,7 +22160,7 @@ paths: type: number repositories: type: array - items: *159 + items: *163 examples: default: &660 value: @@ -22114,7 +22414,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - - *141 + - *145 - *51 requestBody: required: true @@ -22159,9 +22459,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *141 + - *145 - *51 - - *154 + - *158 responses: '204': description: Response @@ -22183,9 +22483,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *141 + - *145 - *51 - - *154 + - *158 responses: '204': description: Response @@ -22208,7 +22508,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - - *141 + - *145 - *51 - *18 - *20 @@ -22250,7 +22550,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - - *141 + - *145 - *51 requestBody: required: true @@ -22295,7 +22595,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - - *141 + - *145 - *51 - *54 responses: @@ -22319,7 +22619,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - - *141 + - *145 - *51 - *54 responses: @@ -22351,7 +22651,7 @@ paths: in: query schema: type: string - - *141 + - *145 - *18 - *20 responses: @@ -22395,7 +22695,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -22403,9 +22703,9 @@ paths: application/json: schema: type: array - items: *160 + items: *164 examples: - default: *161 + default: *165 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22427,7 +22727,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - - *141 + - *145 requestBody: required: true content: @@ -22470,7 +22770,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *162 + '201': *166 '404': *7 '422': *8 x-github: @@ -22500,7 +22800,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *141 + - *145 responses: '201': description: Response @@ -22508,7 +22808,7 @@ paths: application/json: schema: *58 examples: - default: *163 + default: *167 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22536,7 +22836,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *141 + - *145 responses: '201': description: Response @@ -22544,7 +22844,7 @@ paths: application/json: schema: *58 examples: - default: *164 + default: *168 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22566,7 +22866,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - - *141 + - *145 - *54 responses: '200': @@ -22575,7 +22875,7 @@ paths: application/json: schema: *55 examples: - default: *165 + default: *169 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22596,7 +22896,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - - *141 + - *145 - *54 responses: '204': @@ -22622,7 +22922,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *141 + - *145 - *54 responses: '200': *60 @@ -22647,7 +22947,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - - *141 + - *145 - *54 requestBody: required: true @@ -22696,7 +22996,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *141 + - *145 - *54 requestBody: required: true @@ -22746,10 +23046,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - - *141 + - *145 - *54 responses: - '200': *166 + '200': *170 '404': *7 x-github: githubCloudOnly: false @@ -22776,9 +23076,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - - *141 + - *145 - *54 - - *167 + - *171 responses: '200': *60 '404': *7 @@ -22805,7 +23105,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets parameters: - - *141 + - *145 - *18 - *20 responses: @@ -22823,7 +23123,7 @@ paths: type: integer secrets: type: array - items: &168 + items: &172 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -22896,7 +23196,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key parameters: - - *141 + - *145 responses: '200': description: Response @@ -22956,8 +23256,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - - *141 - - &169 + - *145 + - &173 name: secret_name description: The name of the secret. in: path @@ -22969,7 +23269,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *172 examples: default: value: @@ -22999,8 +23299,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 requestBody: required: true content: @@ -23055,7 +23355,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -23081,8 +23381,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 responses: '204': description: Response @@ -23108,8 +23408,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 - *20 - *18 responses: @@ -23127,9 +23427,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *163 examples: - default: &173 + default: &177 value: total_count: 1 repositories: @@ -23221,8 +23521,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 requestBody: required: true content: @@ -23274,8 +23574,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 - name: repository_id in: path required: true @@ -23308,8 +23608,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 - name: repository_id in: path required: true @@ -23341,7 +23641,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - - *141 + - *145 - &348 name: per_page description: The number of results per page (max 30). For more information, @@ -23366,7 +23666,7 @@ paths: type: integer variables: type: array - items: &171 + items: &175 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -23451,7 +23751,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable parameters: - - *141 + - *145 requestBody: required: true content: @@ -23499,7 +23799,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -23524,8 +23824,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - - *141 - - &172 + - *145 + - &176 name: name description: The name of the variable. in: path @@ -23537,7 +23837,7 @@ paths: description: Response content: application/json: - schema: *171 + schema: *175 examples: default: value: @@ -23567,8 +23867,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - - *141 - - *172 + - *145 + - *176 requestBody: required: true content: @@ -23630,8 +23930,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - - *141 - - *172 + - *145 + - *176 responses: '204': description: Response @@ -23657,8 +23957,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *141 - - *172 + - *145 + - *176 - *20 - *18 responses: @@ -23676,9 +23976,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *163 examples: - default: *173 + default: *177 '409': description: Response when the visibility of the variable is not set to `selected` @@ -23704,8 +24004,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *141 - - *172 + - *145 + - *176 requestBody: required: true content: @@ -23754,8 +24054,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *141 - - *172 + - *145 + - *176 - name: repository_id in: path required: true @@ -23789,8 +24089,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *141 - - *172 + - *145 + - *176 - name: repository_id in: path required: true @@ -23821,7 +24121,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -23848,11 +24148,11 @@ paths: required: true content: application/json: - schema: *174 + schema: *178 examples: default: *63 parameters: - - *141 + - *145 responses: '200': description: Response @@ -23876,7 +24176,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - - *141 + - *145 responses: '204': description: Response @@ -23904,7 +24204,7 @@ paths: - *18 - *76 - *77 - - *141 + - *145 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -24063,7 +24363,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-the-audit-log-for-an-organization parameters: - - *141 + - *145 - name: phrase description: A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). @@ -24071,10 +24371,10 @@ paths: required: false schema: type: string - - *175 - - *176 - - *177 - - *178 + - *179 + - *180 + - *181 + - *182 - *18 responses: '200': @@ -24083,9 +24383,9 @@ paths: application/json: schema: type: array - items: *179 + items: *183 examples: - default: *180 + default: *184 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -24102,7 +24402,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *141 + - *145 - *18 - *20 responses: @@ -24114,7 +24414,7 @@ paths: type: array items: *19 examples: - default: &241 + default: &245 value: - login: octocat id: 1 @@ -24152,8 +24452,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *141 - - &181 + - *145 + - &185 name: username description: The handle for the GitHub user account. in: path @@ -24184,8 +24484,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response @@ -24205,8 +24505,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response @@ -24231,9 +24531,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *141 - - *182 - - *183 + - *145 + - *186 + - *187 - *76 - *77 - *20 @@ -24244,7 +24544,7 @@ paths: be returned. in: query required: false - schema: *184 + schema: *188 - name: sort description: The property by which to sort the results. in: query @@ -24278,13 +24578,13 @@ paths: application/json: schema: type: array - items: *185 + items: *189 examples: - default: *186 + default: *190 headers: Link: *39 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24306,7 +24606,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *141 + - *145 - name: target_type in: query description: The target type of the code security configuration @@ -24334,7 +24634,7 @@ paths: application/json: schema: type: array - items: &187 + items: &191 type: object description: A code security configuration properties: @@ -24573,7 +24873,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration parameters: - - *141 + - *145 requestBody: required: true content: @@ -24745,9 +25045,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *187 + schema: *191 examples: - default: &188 + default: &193 value: id: 1325 target_type: organization @@ -24793,7 +25093,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations parameters: - - *141 + - *145 responses: '200': description: Response @@ -24813,7 +25113,7 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *187 + configuration: *191 examples: default: value: @@ -24897,7 +25197,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *141 + - *145 requestBody: required: true content: @@ -24920,12 +25220,11 @@ paths: - 32 - 91 responses: - '204': &190 - description: A header with no content is returned. + '204': *192 '400': *15 '403': *29 '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24947,8 +25246,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration parameters: - - *141 - - &189 + - *145 + - &194 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -24960,9 +25259,9 @@ paths: description: Response content: application/json: - schema: *187 + schema: *191 examples: - default: *188 + default: *193 '304': *37 '403': *29 '404': *7 @@ -24986,8 +25285,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration parameters: - - *141 - - *189 + - *145 + - *194 requestBody: required: true content: @@ -25139,7 +25438,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *187 + schema: *191 examples: default: value: @@ -25190,14 +25489,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *141 - - *189 + - *145 + - *194 responses: - '204': *190 + '204': *192 '400': *15 '403': *29 '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25221,8 +25520,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *141 - - *189 + - *145 + - *194 requestBody: required: true content: @@ -25261,7 +25560,7 @@ paths: - 32 - 91 responses: - '202': *147 + '202': *151 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25285,8 +25584,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - - *141 - - *189 + - *145 + - *194 requestBody: required: true content: @@ -25326,12 +25625,12 @@ paths: - none - private_and_internal - public - configuration: *187 + configuration: *191 examples: default: value: default_for_new_repos: all - configuration: *188 + configuration: *193 '403': *29 '404': *7 x-github: @@ -25355,8 +25654,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *141 - - *189 + - *145 + - *194 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -25499,7 +25798,7 @@ paths: parameters: - *18 - *20 - - *141 + - *145 responses: '200': description: Response @@ -25515,7 +25814,7 @@ paths: type: integer codespaces: type: array - items: &242 + items: &246 type: object title: Codespace description: A codespace. @@ -25540,7 +25839,7 @@ paths: nullable: true owner: *19 billable_owner: *19 - repository: *159 + repository: *163 machine: type: object title: Codespace machine @@ -25792,7 +26091,7 @@ paths: - pulls_url - recent_folders examples: - default: &243 + default: &247 value: total_count: 3 codespaces: @@ -26224,7 +26523,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *141 + - *145 deprecated: true requestBody: required: true @@ -26291,7 +26590,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *141 + - *145 deprecated: true requestBody: required: true @@ -26346,7 +26645,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *141 + - *145 requestBody: required: true content: @@ -26398,7 +26697,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *141 + - *145 - *18 - *20 responses: @@ -26416,7 +26715,7 @@ paths: type: integer secrets: type: array - items: &191 + items: &195 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -26487,7 +26786,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *141 + - *145 responses: '200': description: Response @@ -26545,14 +26844,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 responses: '200': description: Response content: application/json: - schema: *191 + schema: *195 examples: default: &436 value: @@ -26581,8 +26880,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 requestBody: required: true content: @@ -26637,7 +26936,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -26663,8 +26962,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 responses: '204': description: Response @@ -26689,8 +26988,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 - *20 - *18 responses: @@ -26708,9 +27007,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *163 examples: - default: *173 + default: *177 '404': *7 x-github: githubCloudOnly: false @@ -26732,8 +27031,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 requestBody: required: true content: @@ -26783,8 +27082,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 - name: repository_id in: path required: true @@ -26817,8 +27116,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 - name: repository_id in: path required: true @@ -26857,7 +27156,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - - *141 + - *145 responses: '200': description: OK @@ -27000,7 +27299,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - - *141 + - *145 - *20 - name: per_page description: The number of results per page (max 100). For more information, @@ -27023,9 +27322,9 @@ paths: currently being billed. seats: type: array - items: *192 + items: *196 examples: - default: *193 + default: *197 headers: Link: *39 '500': *84 @@ -27047,13 +27346,11 @@ paths: Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-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. + Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." - The response will contain the total number of new seats that were created and existing seats that were refreshed. + The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -27063,7 +27360,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - - *141 + - *145 requestBody: content: application/json: @@ -27127,14 +27424,11 @@ paths: Sets seats for all members of each team specified to "pending cancellation". This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - - For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. - The response will contain the total number of seats set to "pending cancellation". + The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -27144,7 +27438,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - - *141 + - *145 requestBody: content: application/json: @@ -27210,13 +27504,11 @@ paths: Purchases a GitHub Copilot seat for each user specified. The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-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. + Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." - The response will contain the total number of new seats that were created and existing seats that were refreshed. + The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -27226,7 +27518,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - - *141 + - *145 requestBody: content: application/json: @@ -27289,14 +27581,11 @@ paths: Sets seats for all users specified to "pending cancellation". This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - - For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. - The response will contain the total number of seats set to "pending cancellation". + The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -27306,7 +27595,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - - *141 + - *145 requestBody: content: application/json: @@ -27387,7 +27676,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *141 + - *145 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -27419,13 +27708,13 @@ paths: application/json: schema: type: array - items: *98 + items: *102 examples: - default: *99 + default: *103 '500': *84 '403': *29 '404': *7 - '422': *100 + '422': *104 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27456,7 +27745,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-organization-members parameters: - - *141 + - *145 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -27488,9 +27777,9 @@ paths: application/json: schema: type: array - items: *101 + items: *105 examples: - default: *194 + default: *198 '500': *84 '401': *25 '403': *29 @@ -27516,7 +27805,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization parameters: - - *141 + - *145 - *18 - name: page description: Page token @@ -27660,7 +27949,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization parameters: - - *141 + - *145 - name: credential_id in: path required: true @@ -27691,7 +27980,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization parameters: - - *141 + - *145 responses: '200': description: Response - list of custom role names @@ -27706,7 +27995,7 @@ paths: type: integer custom_roles: type: array - items: *195 + items: *199 examples: default: value: @@ -27793,12 +28082,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role parameters: - - *141 + - *145 requestBody: required: true content: application/json: - schema: &198 + schema: &202 type: object properties: name: @@ -27839,9 +28128,9 @@ paths: description: Response content: application/json: - schema: *195 + schema: *199 examples: - default: *196 + default: *200 '422': *16 '404': *7 x-github: @@ -27865,8 +28154,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role parameters: - - *141 - - &197 + - *145 + - &201 name: role_id description: The unique identifier of the role. in: path @@ -27878,9 +28167,9 @@ paths: description: Response content: application/json: - schema: *195 + schema: *199 examples: - default: *196 + default: *200 '404': *7 x-github: githubCloudOnly: true @@ -27902,13 +28191,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role parameters: - - *141 - - *197 + - *145 + - *201 requestBody: required: true content: application/json: - schema: &199 + schema: &203 type: object properties: name: @@ -27946,9 +28235,9 @@ paths: description: Response content: application/json: - schema: *195 + schema: *199 examples: - default: *196 + default: *200 '422': *16 '404': *7 x-github: @@ -27972,8 +28261,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - - *141 - - *197 + - *145 + - *201 responses: '204': description: Response @@ -28001,12 +28290,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---create-a-custom-role parameters: - - *141 + - *145 requestBody: required: true content: application/json: - schema: *198 + schema: *202 examples: default: value: @@ -28020,9 +28309,9 @@ paths: description: Response content: application/json: - schema: *195 + schema: *199 examples: - default: *196 + default: *200 '422': *16 '404': *7 x-github: @@ -28052,16 +28341,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---get-a-custom-role parameters: - - *141 - - *197 + - *145 + - *201 responses: '200': description: Response content: application/json: - schema: *195 + schema: *199 examples: - default: *196 + default: *200 '404': *7 x-github: githubCloudOnly: true @@ -28089,13 +28378,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---update-a-custom-role parameters: - - *141 - - *197 + - *145 + - *201 requestBody: required: true content: application/json: - schema: *199 + schema: *203 examples: default: value: @@ -28110,9 +28399,9 @@ paths: description: Response content: application/json: - schema: *195 + schema: *199 examples: - default: *196 + default: *200 '422': *16 '404': *7 x-github: @@ -28142,8 +28431,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---delete-a-custom-role parameters: - - *141 - - *197 + - *145 + - *201 responses: '204': description: Response @@ -28171,18 +28460,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *141 - - *200 - - *201 - - *202 - - *203 + - *145 - *204 - *205 + - *206 + - *207 + - *208 + - *209 - *78 - *76 - *77 - - *206 - - *207 + - *210 + - *211 - *18 responses: '200': @@ -28191,9 +28480,9 @@ paths: application/json: schema: type: array - items: *208 + items: *212 examples: - default: *209 + default: *213 '304': *37 '400': *15 '403': *29 @@ -28219,7 +28508,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets parameters: - - *141 + - *145 - *18 - *20 responses: @@ -28237,7 +28526,7 @@ paths: type: integer secrets: type: array - items: &210 + items: &214 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -28308,7 +28597,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key parameters: - - *141 + - *145 responses: '200': description: Response @@ -28354,14 +28643,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 responses: '200': description: Response content: application/json: - schema: *210 + schema: *214 examples: default: value: @@ -28389,8 +28678,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 requestBody: required: true content: @@ -28445,7 +28734,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -28469,8 +28758,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 responses: '204': description: Response @@ -28494,8 +28783,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 - *20 - *18 responses: @@ -28513,9 +28802,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *163 examples: - default: *173 + default: *177 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28536,8 +28825,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 requestBody: required: true content: @@ -28587,8 +28876,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 - name: repository_id in: path required: true @@ -28619,8 +28908,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 - name: repository_id in: path required: true @@ -28650,7 +28939,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -28658,7 +28947,7 @@ paths: application/json: schema: type: array - items: &254 + items: &258 title: Package description: A software package type: object @@ -28708,8 +28997,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *211 - required: *212 + properties: *215 + required: *216 nullable: true created_at: type: string @@ -28728,7 +29017,7 @@ paths: - created_at - updated_at examples: - default: &255 + default: &259 value: - id: 197 name: hello_docker @@ -28806,7 +29095,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events parameters: - - *141 + - *145 - *18 - *20 responses: @@ -28816,7 +29105,7 @@ paths: application/json: schema: type: array - items: *130 + items: *134 examples: 200-response: value: @@ -28886,7 +29175,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group parameters: - - *141 + - *145 - name: group_id description: The unique identifier of the group. in: path @@ -29031,7 +29320,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-external-groups-in-an-organization parameters: - - *141 + - *145 - *18 - name: page description: Page token @@ -29119,7 +29408,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations parameters: - - *141 + - *145 - *18 - *20 responses: @@ -29129,7 +29418,7 @@ paths: application/json: schema: type: array - items: &235 + items: &239 title: Organization Invitation description: Organization Invitation type: object @@ -29176,7 +29465,7 @@ paths: - invitation_teams_url - node_id examples: - default: &236 + default: &240 value: - id: 1 login: monalisa @@ -29235,7 +29524,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -29288,7 +29577,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks parameters: - - *141 + - *145 - *18 - *20 responses: @@ -29298,7 +29587,7 @@ paths: application/json: schema: type: array - items: &213 + items: &217 title: Org Hook description: Org Hook type: object @@ -29407,7 +29696,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook parameters: - - *141 + - *145 requestBody: required: true content: @@ -29467,9 +29756,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *217 examples: - default: &214 + default: &218 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -29513,8 +29802,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - - *141 - - &215 + - *145 + - &219 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. @@ -29527,9 +29816,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *217 examples: - default: *214 + default: *218 '404': *7 x-github: githubCloudOnly: false @@ -29550,8 +29839,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - - *141 - - *215 + - *145 + - *219 requestBody: required: false content: @@ -29596,7 +29885,7 @@ paths: description: Response content: application/json: - schema: *213 + schema: *217 examples: default: value: @@ -29635,8 +29924,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *141 - - *215 + - *145 + - *219 responses: '204': description: Response @@ -29661,8 +29950,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *141 - - *215 + - *145 + - *219 responses: '200': description: Response @@ -29690,8 +29979,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *141 - - *215 + - *145 + - *219 requestBody: required: false content: @@ -29739,10 +30028,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *141 - - *215 + - *145 + - *219 - *18 - - *216 + - *220 responses: '200': description: Response @@ -29750,9 +30039,9 @@ paths: application/json: schema: type: array - items: *217 + items: *221 examples: - default: *218 + default: *222 '400': *15 '422': *16 x-github: @@ -29775,17 +30064,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *141 - - *215 + - *145 + - *219 - *17 responses: '200': description: Response content: application/json: - schema: *219 + schema: *223 examples: - default: *220 + default: *224 '400': *15 '422': *16 x-github: @@ -29808,11 +30097,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *141 - - *215 + - *145 + - *219 - *17 responses: - '202': *147 + '202': *151 '400': *15 '422': *16 x-github: @@ -29835,8 +30124,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *141 - - *215 + - *145 + - *219 responses: '204': description: Response @@ -29858,8 +30147,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *141 - - &225 + - *145 + - &229 name: actor_type in: path description: The type of the actor @@ -29872,14 +30161,14 @@ paths: - fine_grained_pats - oauth_apps - github_apps_user_to_server - - &226 + - &230 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &221 + - &225 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -29887,7 +30176,7 @@ paths: required: true schema: type: string - - &222 + - &226 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -29973,13 +30262,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats parameters: - - *141 - - *221 - - *222 + - *145 + - *225 + - *226 - *20 - *18 - *78 - - &231 + - &235 name: sort description: The property to sort the results by. in: query @@ -30050,15 +30339,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats parameters: - - *141 - - *221 - - *222 + - *145 + - *225 + - *226 responses: '200': description: Response content: application/json: - schema: &223 + schema: &227 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -30074,7 +30363,7 @@ paths: type: integer format: int64 examples: - default: &224 + default: &228 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -30094,24 +30383,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *141 - - &227 + - *145 + - &231 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *221 - - *222 + - *225 + - *226 responses: '200': description: Response content: application/json: - schema: *223 + schema: *227 examples: - default: *224 + default: *228 x-github: enabledForGitHubApps: true category: orgs @@ -30129,19 +30418,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *141 - - *221 - - *222 + - *145 - *225 - *226 + - *229 + - *230 responses: '200': description: Response content: application/json: - schema: *223 + schema: *227 examples: - default: *224 + default: *228 x-github: enabledForGitHubApps: true category: orgs @@ -30158,10 +30447,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats parameters: - - *141 - - *221 - - *222 - - &228 + - *145 + - *225 + - *226 + - &232 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -30174,7 +30463,7 @@ paths: description: Response content: application/json: - schema: &229 + schema: &233 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -30190,7 +30479,7 @@ paths: type: integer format: int64 examples: - default: &230 + default: &234 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -30226,19 +30515,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user parameters: - - *141 - - *227 - - *221 - - *222 - - *228 + - *145 + - *231 + - *225 + - *226 + - *232 responses: '200': description: Response content: application/json: - schema: *229 + schema: *233 examples: - default: *230 + default: *234 x-github: enabledForGitHubApps: true category: orgs @@ -30255,20 +30544,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *141 + - *145 + - *229 + - *230 - *225 - *226 - - *221 - - *222 - - *228 + - *232 responses: '200': description: Response content: application/json: - schema: *229 + schema: *233 examples: - default: *230 + default: *234 x-github: enabledForGitHubApps: true category: orgs @@ -30285,14 +30574,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats parameters: - - *141 - - *227 - - *221 - - *222 + - *145 + - *231 + - *225 + - *226 - *20 - *18 - *78 - - *231 + - *235 responses: '200': description: Response @@ -30358,7 +30647,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *141 + - *145 responses: '200': description: Response @@ -30435,7 +30724,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *141 + - *145 - *18 - *20 responses: @@ -30524,7 +30813,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -30532,12 +30821,12 @@ paths: application/json: schema: anyOf: - - &233 + - &237 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &232 + limit: &236 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -30562,7 +30851,7 @@ paths: properties: {} additionalProperties: false examples: - default: &234 + default: &238 value: limit: collaborators_only origin: organization @@ -30586,7 +30875,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *141 + - *145 requestBody: required: true content: @@ -30597,7 +30886,7 @@ paths: duration type: object properties: - limit: *232 + limit: *236 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -30621,9 +30910,9 @@ paths: description: Response content: application/json: - schema: *233 + schema: *237 examples: - default: *234 + default: *238 '422': *16 x-github: githubCloudOnly: false @@ -30641,7 +30930,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *141 + - *145 responses: '204': description: Response @@ -30667,7 +30956,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations parameters: - - *141 + - *145 - *18 - *20 - name: role @@ -30701,9 +30990,9 @@ paths: application/json: schema: type: array - items: *235 + items: *239 examples: - default: *236 + default: *240 headers: Link: *39 '404': *7 @@ -30727,7 +31016,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation parameters: - - *141 + - *145 requestBody: required: false content: @@ -30781,7 +31070,7 @@ paths: description: Response content: application/json: - schema: *235 + schema: *239 examples: default: value: @@ -30837,8 +31126,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - - *141 - - &237 + - *145 + - &241 name: invitation_id description: The unique identifier of the invitation. in: path @@ -30871,8 +31160,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - - *141 - - *237 + - *145 + - *241 - *18 - *20 responses: @@ -30882,9 +31171,9 @@ paths: application/json: schema: type: array - items: *238 + items: *242 examples: - default: &253 + default: &257 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -30929,7 +31218,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *141 + - *145 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -30959,7 +31248,7 @@ paths: - closed - all default: open - - *239 + - *243 - name: sort description: What to sort results by. in: query @@ -30972,7 +31261,7 @@ paths: - comments default: created - *78 - - *108 + - *112 - *18 - *20 responses: @@ -30982,9 +31271,9 @@ paths: application/json: schema: type: array - items: *118 + items: *122 examples: - default: *240 + default: *244 headers: Link: *39 '404': *7 @@ -31006,7 +31295,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members parameters: - - *141 + - *145 - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -31042,7 +31331,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 '422': *16 @@ -31062,8 +31351,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response if requester is an organization member and user is @@ -31094,8 +31383,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response @@ -31121,8 +31410,8 @@ paths: parameters: - *18 - *20 - - *141 - - *181 + - *145 + - *185 responses: '200': description: Response @@ -31138,9 +31427,9 @@ paths: type: integer codespaces: type: array - items: *242 + items: *246 examples: - default: *243 + default: *247 '304': *37 '500': *84 '401': *25 @@ -31165,9 +31454,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *141 - - *181 - - &244 + - *145 + - *185 + - &248 name: codespace_name in: path required: true @@ -31175,7 +31464,7 @@ paths: schema: type: string responses: - '202': *147 + '202': *151 '304': *37 '500': *84 '401': *25 @@ -31200,15 +31489,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *141 - - *181 - - *244 + - *145 + - *185 + - *248 responses: '200': description: Response content: application/json: - schema: *242 + schema: *246 examples: default: &429 value: @@ -31383,14 +31672,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - - *141 - - *181 + - *145 + - *185 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *192 + schema: *196 examples: default: value: @@ -31458,14 +31747,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user parameters: - - *141 - - *181 + - *145 + - *185 responses: '200': description: Response content: application/json: - schema: &245 + schema: &249 title: Org Membership description: Org Membership type: object @@ -31517,7 +31806,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &246 + response-if-user-has-an-active-admin-membership-with-organization: &250 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -31585,8 +31874,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user parameters: - - *141 - - *181 + - *145 + - *185 requestBody: required: false content: @@ -31614,9 +31903,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *249 examples: - response-if-user-already-had-membership-with-organization: *246 + response-if-user-already-had-membership-with-organization: *250 '422': *16 '403': *29 x-github: @@ -31637,8 +31926,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response @@ -31663,7 +31952,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations parameters: - - *141 + - *145 - *18 - *20 - name: exclude @@ -31684,7 +31973,7 @@ paths: application/json: schema: type: array - items: &247 + items: &251 title: Migration description: A migration. type: object @@ -31937,7 +32226,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration parameters: - - *141 + - *145 requestBody: required: true content: @@ -32013,7 +32302,7 @@ paths: description: Response content: application/json: - schema: *247 + schema: *251 examples: default: value: @@ -32191,8 +32480,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - - *141 - - &248 + - *145 + - &252 name: migration_id description: The unique identifier of the migration. in: path @@ -32219,7 +32508,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *247 + schema: *251 examples: default: value: @@ -32388,8 +32677,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *141 - - *248 + - *145 + - *252 responses: '302': description: Response @@ -32410,8 +32699,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *141 - - *248 + - *145 + - *252 responses: '204': description: Response @@ -32434,8 +32723,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - - *141 - - *248 + - *145 + - *252 - &674 name: repo_name description: repo_name parameter @@ -32463,8 +32752,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *141 - - *248 + - *145 + - *252 - *18 - *20 responses: @@ -32474,9 +32763,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: &260 + default: &264 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -32615,7 +32904,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -32669,7 +32958,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response - list of organization roles @@ -32685,7 +32974,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &249 + items: &253 title: Organization Role description: Organization roles type: object @@ -32845,7 +33134,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role parameters: - - *141 + - *145 requestBody: required: true content: @@ -32892,7 +33181,7 @@ paths: description: Response content: application/json: - schema: *249 + schema: *253 examples: default: value: @@ -32921,7 +33210,7 @@ paths: updated_at: '2022-07-04T22:19:11Z' '422': *16 '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -32943,8 +33232,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *141 - - *250 + - *145 + - *254 responses: '204': description: Response @@ -32969,9 +33258,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *141 - - *250 - - *197 + - *145 + - *254 + - *201 responses: '204': description: Response @@ -33000,9 +33289,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *141 - - *250 - - *197 + - *145 + - *254 + - *201 responses: '204': description: Response @@ -33027,8 +33316,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response @@ -33053,9 +33342,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *141 - - *181 - - *197 + - *145 + - *185 + - *201 responses: '204': description: Response @@ -33085,9 +33374,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *141 - - *181 - - *197 + - *145 + - *185 + - *201 responses: '204': description: Response @@ -33115,14 +33404,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role parameters: - - *141 - - *197 + - *145 + - *201 responses: '200': description: Response content: application/json: - schema: *249 + schema: *253 examples: default: value: @@ -33179,8 +33468,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role parameters: - - *141 - - *197 + - *145 + - *201 requestBody: required: true content: @@ -33219,7 +33508,7 @@ paths: description: Response content: application/json: - schema: *249 + schema: *253 examples: default: value: @@ -33247,7 +33536,7 @@ paths: created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': *16 - '409': *146 + '409': *150 '404': *7 x-github: githubCloudOnly: true @@ -33272,8 +33561,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - - *141 - - *197 + - *145 + - *201 responses: '204': description: Response @@ -33298,8 +33587,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - - *141 - - *197 + - *145 + - *201 - *18 - *20 responses: @@ -33377,8 +33666,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *251 - required: *252 + properties: *255 + required: *256 nullable: true required: - id @@ -33393,7 +33682,7 @@ paths: - slug - parent examples: - default: *253 + default: *257 headers: Link: *39 '404': @@ -33422,8 +33711,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - - *141 - - *197 + - *145 + - *201 - *18 - *20 responses: @@ -33456,8 +33745,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *251 - required: *252 + properties: *255 + required: *256 name: nullable: true type: string @@ -33552,7 +33841,7 @@ paths: - type - url examples: - default: *241 + default: *245 headers: Link: *39 '404': @@ -33576,7 +33865,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *141 + - *145 - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -33600,7 +33889,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 x-github: @@ -33625,8 +33914,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *141 - - *181 + - *145 + - *185 requestBody: required: false content: @@ -33683,8 +33972,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response @@ -33741,7 +34030,7 @@ paths: - docker - nuget - container - - *141 + - *145 - &676 name: visibility description: |- @@ -33778,9 +34067,9 @@ paths: application/json: schema: type: array - items: *254 + items: *258 examples: - default: *255 + default: *259 '403': *29 '401': *25 '400': &678 @@ -33805,7 +34094,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &256 + - &260 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -33823,20 +34112,20 @@ paths: - docker - nuget - container - - &257 + - &261 name: package_name description: The name of the package. in: path required: true schema: type: string - - *141 + - *145 responses: '200': description: Response content: application/json: - schema: *254 + schema: *258 examples: default: value: @@ -33888,9 +34177,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *256 - - *257 - - *141 + - *260 + - *261 + - *145 responses: '204': description: Response @@ -33922,9 +34211,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *256 - - *257 - - *141 + - *260 + - *261 + - *145 - name: token description: package token schema: @@ -33956,9 +34245,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *256 - - *257 - - *141 + - *260 + - *261 + - *145 - *20 - *18 - name: state @@ -33978,7 +34267,7 @@ paths: application/json: schema: type: array - items: &258 + items: &262 title: Package Version description: A version of a software package type: object @@ -34103,10 +34392,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *256 - - *257 - - *141 - - &259 + - *260 + - *261 + - *145 + - &263 name: package_version_id description: Unique identifier of the package version. in: path @@ -34118,7 +34407,7 @@ paths: description: Response content: application/json: - schema: *258 + schema: *262 examples: default: value: @@ -34154,10 +34443,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *256 - - *257 - - *141 - - *259 + - *260 + - *261 + - *145 + - *263 responses: '204': description: Response @@ -34189,10 +34478,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *256 - - *257 - - *141 - - *259 + - *260 + - *261 + - *145 + - *263 responses: '204': description: Response @@ -34219,10 +34508,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *141 + - *145 - *18 - *20 - - &261 + - &265 name: sort description: The property by which to sort the results. in: query @@ -34233,7 +34522,7 @@ paths: - created_at default: created_at - *78 - - &262 + - &266 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -34244,7 +34533,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &263 + - &267 name: repository description: The name of the repository to use to filter the results. in: query @@ -34252,7 +34541,7 @@ paths: schema: type: string example: Hello-World - - &264 + - &268 name: permission description: The permission to use to filter the results. in: query @@ -34260,7 +34549,7 @@ paths: schema: type: string example: issues_read - - &265 + - &269 name: last_used_before description: 'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -34270,7 +34559,7 @@ paths: schema: type: string format: date-time - - &266 + - &270 name: last_used_after description: 'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -34433,7 +34722,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *141 + - *145 requestBody: required: true content: @@ -34478,7 +34767,7 @@ paths: '422': *16 '404': *7 '403': *29 - '202': *147 + '202': *151 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34499,7 +34788,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - - *141 + - *145 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -34539,7 +34828,7 @@ paths: '422': *16 '404': *7 '403': *29 - '204': *190 + '204': *192 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34560,7 +34849,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - - *141 + - *145 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -34580,9 +34869,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: *260 + default: *264 headers: Link: *39 x-github: @@ -34605,16 +34894,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - - *141 + - *145 - *18 - *20 - - *261 - - *78 - - *262 - - *263 - - *264 - *265 + - *78 - *266 + - *267 + - *268 + - *269 + - *270 responses: '500': *84 '422': *16 @@ -34763,7 +35052,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - - *141 + - *145 requestBody: required: true content: @@ -34800,7 +35089,7 @@ paths: responses: '500': *84 '404': *7 - '202': *147 + '202': *151 '403': *29 '422': *16 x-github: @@ -34823,7 +35112,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - - *141 + - *145 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -34853,7 +35142,7 @@ paths: responses: '500': *84 '404': *7 - '204': *190 + '204': *192 '403': *29 '422': *16 x-github: @@ -34875,7 +35164,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - - *141 + - *145 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -34894,9 +35183,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: *260 + default: *264 headers: Link: *39 x-github: @@ -34918,7 +35207,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-organization-projects parameters: - - *141 + - *145 - name: state description: Indicates the state of the projects to return. in: query @@ -34939,7 +35228,7 @@ paths: application/json: schema: type: array - items: &267 + items: &271 title: Project description: Projects are a way to organize columns and cards of work. @@ -35083,7 +35372,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#create-an-organization-project parameters: - - *141 + - *145 requestBody: required: true content: @@ -35109,7 +35398,7 @@ paths: description: Response content: application/json: - schema: *267 + schema: *271 examples: default: value: @@ -35171,7 +35460,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -35179,94 +35468,9 @@ paths: application/json: schema: type: array - items: &268 - title: Organization Custom Property - description: Custom property defined on an organization - type: object - properties: - property_name: - type: string - description: The name of the property - url: - type: string - format: uri - description: The URL that can be used to fetch, update, or delete - info about this property via the API. - source_type: - type: string - description: The source type of the property - enum: - - organization - - enterprise - example: organization - value_type: - type: string - example: single_select - enum: - - string - - single_select - - multi_select - - true_false - description: The type of the value for the property - required: - type: boolean - description: Whether the property is required. - default_value: - oneOf: - - type: string - - type: array - items: - type: string - nullable: true - description: Default value of the property - description: - type: string - nullable: true - description: Short description of the property - allowed_values: - type: array - items: - type: string - maxLength: 75 - maxItems: 200 - nullable: true - description: |- - An ordered list of the allowed values of the property. - The property can have up to 200 allowed values. - values_editable_by: - type: string - nullable: true - enum: - - org_actors - - org_and_repo_actors - example: org_actors - description: Who can edit the values of the property - required: - - property_name - - value_type + items: *96 examples: - default: &269 - value: - - property_name: environment - url: https://api.github.com/orgs/github/properties/schema/environment - source_type: organization - value_type: single_select - required: true - default_value: production - description: Prod or dev environment - allowed_values: - - production - - development - values_editable_by: org_actors - - property_name: service - url: https://api.github.com/orgs/github/properties/schema/service - source_type: organization - value_type: string - - property_name: team - url: https://api.github.com/orgs/github/properties/schema/team - source_type: organization - value_type: string - description: Team owning the repository + default: *97 '403': *29 '404': *7 x-github: @@ -35289,7 +35493,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *141 + - *145 requestBody: required: true content: @@ -35300,7 +35504,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *268 + items: *96 minItems: 1 maxItems: 100 required: @@ -35330,9 +35534,9 @@ paths: application/json: schema: type: array - items: *268 + items: *96 examples: - default: *269 + default: *97 '403': *29 '404': *7 x-github: @@ -35353,33 +35557,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *141 - - &270 - name: custom_property_name - description: The custom property name - in: path - required: true - schema: - type: string + - *145 + - *98 responses: '200': description: Response content: application/json: - schema: *268 + schema: *96 examples: - default: &271 - value: - property_name: environment - url: https://api.github.com/orgs/github/properties/schema/environment - source_type: organization - value_type: single_select - required: true - default_value: production - description: Prod or dev environment - allowed_values: - - production - - development + default: *99 '403': *29 '404': *7 x-github: @@ -35402,8 +35589,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *141 - - *270 + - *145 + - *98 requestBody: required: true content: @@ -35462,9 +35649,9 @@ paths: description: Response content: application/json: - schema: *268 + schema: *96 examples: - default: *271 + default: *99 '403': *29 '404': *7 x-github: @@ -35487,10 +35674,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *141 - - *270 + - *145 + - *98 responses: - '204': *190 + '204': *192 '403': *29 '404': *7 x-github: @@ -35511,7 +35698,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *141 + - *145 - *18 - *20 - name: repository_query @@ -35616,7 +35803,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - - *141 + - *145 requestBody: required: true content: @@ -35677,7 +35864,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members parameters: - - *141 + - *145 - *18 - *20 responses: @@ -35689,7 +35876,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 x-github: @@ -35708,8 +35895,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response if user is a public member @@ -35733,8 +35920,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response @@ -35755,8 +35942,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response @@ -35780,7 +35967,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories parameters: - - *141 + - *145 - name: type description: Specifies the types of repositories you want returned. `internal` is not yet supported when a GitHub App calls this endpoint with an installation @@ -35827,9 +36014,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: *260 + default: *264 headers: Link: *39 x-github: @@ -35850,7 +36037,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository parameters: - - *141 + - *145 requestBody: required: true content: @@ -36397,8 +36584,8 @@ paths: title: License Simple description: License Simple type: object - properties: *119 - required: *120 + properties: *123 + required: *124 nullable: true organization: title: Simple User @@ -37048,7 +37235,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -37080,7 +37267,7 @@ paths: category: orgs subcategory: rules parameters: - - *141 + - *145 - *18 - *20 - &587 @@ -38072,7 +38259,7 @@ paths: category: orgs subcategory: rules parameters: - - *141 + - *145 requestBody: description: Request body required: true @@ -38195,7 +38382,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *141 + - *145 - &588 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally @@ -38352,7 +38539,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *141 + - *145 - &594 name: rule_suite_id description: |- @@ -38529,7 +38716,7 @@ paths: category: orgs subcategory: rules parameters: - - *141 + - *145 - name: ruleset_id description: The ID of the ruleset. in: path @@ -38561,7 +38748,7 @@ paths: category: orgs subcategory: rules parameters: - - *141 + - *145 - name: ruleset_id description: The ID of the ruleset. in: path @@ -38650,7 +38837,7 @@ paths: category: orgs subcategory: rules parameters: - - *141 + - *145 - name: ruleset_id description: The ID of the ruleset. in: path @@ -38678,7 +38865,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *141 + - *145 - *286 - *287 - *288 @@ -38722,7 +38909,7 @@ paths: headers: Link: *39 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38744,7 +38931,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *141 + - *145 - *78 - name: sort description: The property to sort the results by. @@ -39042,7 +39229,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *238 + items: *242 private_fork: readOnly: true nullable: true @@ -39461,7 +39648,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams parameters: - - *141 + - *145 responses: '200': description: Response @@ -39471,7 +39658,7 @@ paths: type: array items: *296 examples: - default: *253 + default: *257 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39494,8 +39681,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - - *141 - - *250 + - *145 + - *254 responses: '204': description: Response @@ -39520,8 +39707,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *141 - - *250 + - *145 + - *254 responses: '204': description: Response @@ -39547,7 +39734,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -39579,7 +39766,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - - *141 + - *145 - *18 - *20 responses: @@ -39611,7 +39798,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -39641,7 +39828,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -39666,7 +39853,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-an-organization parameters: - - *141 + - *145 - *18 - name: page description: Page token @@ -39776,8 +39963,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *141 - - *250 + - *145 + - *254 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -39809,13 +39996,13 @@ paths: application/json: schema: type: array - items: *98 + items: *102 examples: - default: *99 + default: *103 '500': *84 '403': *29 '404': *7 - '422': *100 + '422': *104 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39849,8 +40036,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-a-team parameters: - - *141 - - *250 + - *145 + - *254 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -39882,9 +40069,9 @@ paths: application/json: schema: type: array - items: *101 + items: *105 examples: - default: *194 + default: *198 '500': *84 '401': *25 '403': *29 @@ -39906,7 +40093,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams parameters: - - *141 + - *145 - *18 - *20 responses: @@ -39916,9 +40103,9 @@ paths: application/json: schema: type: array - items: *238 + items: *242 examples: - default: *253 + default: *257 headers: Link: *39 '403': *29 @@ -39940,7 +40127,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team parameters: - - *141 + - *145 requestBody: required: true content: @@ -40075,8 +40262,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *251 - required: *252 + properties: *255 + required: *256 nullable: true members_count: type: integer @@ -40392,8 +40579,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - - *141 - - *250 + - *145 + - *254 responses: '200': description: Response @@ -40422,8 +40609,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - - *141 - - *250 + - *145 + - *254 requestBody: required: false content: @@ -40519,8 +40706,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - - *141 - - *250 + - *145 + - *254 responses: '204': description: Response @@ -40546,8 +40733,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - - *141 - - *250 + - *145 + - *254 - *78 - *18 - *20 @@ -40643,7 +40830,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *106 + reactions: *110 required: - author - body @@ -40737,8 +40924,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - - *141 - - *250 + - *145 + - *254 requestBody: required: true content: @@ -40846,8 +41033,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - - *141 - - *250 + - *145 + - *254 - &309 name: discussion_number description: The number that identifies the discussion. @@ -40884,8 +41071,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - - *141 - - *250 + - *145 + - *254 - *309 requestBody: required: false @@ -40981,8 +41168,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - - *141 - - *250 + - *145 + - *254 - *309 responses: '204': @@ -41009,8 +41196,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - - *141 - - *250 + - *145 + - *254 - *309 - *78 - *18 @@ -41079,7 +41266,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *106 + reactions: *110 required: - author - body @@ -41162,8 +41349,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *141 - - *250 + - *145 + - *254 - *309 requestBody: required: true @@ -41254,8 +41441,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *141 - - *250 + - *145 + - *254 - *309 - &312 name: comment_number @@ -41293,8 +41480,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *141 - - *250 + - *145 + - *254 - *309 - *312 requestBody: @@ -41384,8 +41571,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *141 - - *250 + - *145 + - *254 - *309 - *312 responses: @@ -41413,8 +41600,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *141 - - *250 + - *145 + - *254 - *309 - *312 - name: content @@ -41535,8 +41722,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *141 - - *250 + - *145 + - *254 - *309 - *312 requestBody: @@ -41627,8 +41814,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *141 - - *250 + - *145 + - *254 - *309 - *312 - &316 @@ -41663,8 +41850,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *141 - - *250 + - *145 + - *254 - *309 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -41719,8 +41906,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *141 - - *250 + - *145 + - *254 - *309 requestBody: required: true @@ -41785,8 +41972,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *141 - - *250 + - *145 + - *254 - *309 - *316 responses: @@ -41811,8 +41998,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team parameters: - - *141 - - *250 + - *145 + - *254 responses: '200': description: Response @@ -41839,8 +42026,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team parameters: - - *141 - - *250 + - *145 + - *254 requestBody: required: true content: @@ -41884,8 +42071,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team parameters: - - *141 - - *250 + - *145 + - *254 responses: '204': description: Response @@ -41909,8 +42096,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - - *141 - - *250 + - *145 + - *254 - *18 - *20 responses: @@ -41920,9 +42107,9 @@ paths: application/json: schema: type: array - items: *235 + items: *239 examples: - default: *236 + default: *240 headers: Link: *39 x-github: @@ -41944,8 +42131,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - - *141 - - *250 + - *145 + - *254 - name: role description: Filters members returned by their role in the team. in: query @@ -41968,7 +42155,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 x-github: @@ -41998,9 +42185,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - - *141 - - *250 - - *181 + - *145 + - *254 + - *185 responses: '200': description: Response @@ -42069,9 +42256,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *141 - - *250 - - *181 + - *145 + - *254 + - *185 requestBody: required: false content: @@ -42133,9 +42320,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - - *141 - - *250 - - *181 + - *145 + - *254 + - *185 responses: '204': description: Response @@ -42161,8 +42348,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - - *141 - - *250 + - *145 + - *254 - *18 - *20 responses: @@ -42301,8 +42488,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - - *141 - - *250 + - *145 + - *254 - &323 name: project_id description: The unique identifier of the project. @@ -42377,8 +42564,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - - *141 - - *250 + - *145 + - *254 - *323 requestBody: required: false @@ -42443,8 +42630,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - - *141 - - *250 + - *145 + - *254 - *323 responses: '204': @@ -42469,8 +42656,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - - *141 - - *250 + - *145 + - *254 - *18 - *20 responses: @@ -42480,9 +42667,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: *260 + default: *264 headers: Link: *39 x-github: @@ -42511,8 +42698,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *141 - - *250 + - *145 + - *254 - *324 - *325 responses: @@ -42543,8 +42730,8 @@ paths: title: License Simple description: License Simple type: object - properties: *119 - required: *120 + properties: *123 + required: *124 nullable: true forks: type: integer @@ -43089,8 +43276,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *141 - - *250 + - *145 + - *254 - *324 - *325 requestBody: @@ -43137,8 +43324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - - *141 - - *250 + - *145 + - *254 - *324 - *325 responses: @@ -43166,8 +43353,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team parameters: - - *141 - - *250 + - *145 + - *254 responses: '200': description: Response @@ -43197,8 +43384,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections parameters: - - *141 - - *250 + - *145 + - *254 requestBody: required: true content: @@ -43273,8 +43460,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - - *141 - - *250 + - *145 + - *254 - *18 - *20 responses: @@ -43284,7 +43471,7 @@ paths: application/json: schema: type: array - items: *238 + items: *242 examples: response-if-child-teams-exist: &656 value: @@ -43339,7 +43526,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *141 + - *145 - name: security_product in: path description: The security feature to enable or disable. @@ -44013,8 +44200,8 @@ paths: application/json: schema: oneOf: - - *144 - - *145 + - *148 + - *149 '503': description: Response content: @@ -44115,7 +44302,7 @@ paths: description: Response content: application/json: - schema: *267 + schema: *271 examples: default: &334 value: @@ -44216,7 +44403,7 @@ paths: description: Response content: application/json: - schema: *267 + schema: *271 examples: default: *334 '404': @@ -44328,7 +44515,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 '404': *7 @@ -44354,7 +44541,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#add-project-collaborator parameters: - *323 - - *181 + - *185 requestBody: required: false content: @@ -44402,7 +44589,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#remove-user-as-a-collaborator parameters: - *323 - - *181 + - *185 responses: '204': description: Response @@ -44431,7 +44618,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#get-project-permission-for-a-user parameters: - *323 - - *181 + - *185 responses: '200': description: Response @@ -46467,7 +46654,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -46577,7 +46764,7 @@ paths: description: Empty response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -46774,7 +46961,7 @@ paths: type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *42 - selected_actions_url: *152 + selected_actions_url: *156 required: - enabled examples: @@ -47000,7 +47187,7 @@ paths: description: Response content: application/json: - schema: *155 + schema: *159 examples: default: *48 x-github: @@ -47035,7 +47222,7 @@ paths: required: true content: application/json: - schema: *156 + schema: *160 examples: default: *48 x-github: @@ -47118,9 +47305,9 @@ paths: application/json: schema: type: array - items: *160 + items: *164 examples: - default: *161 + default: *165 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47186,7 +47373,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *162 + '201': *166 '404': *7 '422': *8 x-github: @@ -47225,7 +47412,7 @@ paths: application/json: schema: *58 examples: - default: *163 + default: *167 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47262,7 +47449,7 @@ paths: application/json: schema: *58 examples: - default: *164 + default: *168 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47294,7 +47481,7 @@ paths: application/json: schema: *55 examples: - default: *165 + default: *169 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47473,7 +47660,7 @@ paths: - *325 - *54 responses: - '200': *166 + '200': *170 '404': *7 x-github: githubCloudOnly: false @@ -47503,7 +47690,7 @@ paths: - *324 - *325 - *54 - - *167 + - *171 responses: '200': *60 '404': *7 @@ -47905,8 +48092,8 @@ paths: - author - committer nullable: true - repository: *159 - head_repository: *159 + repository: *163 + head_repository: *163 head_repository_id: type: integer example: 5 @@ -48592,7 +48779,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -48882,11 +49069,11 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48986,11 +49173,11 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49202,7 +49389,7 @@ paths: reviewer: anyOf: - *19 - - *238 + - *242 required: - environment - wait_timer @@ -49414,8 +49601,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 required: - id - node_id @@ -49511,7 +49698,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -49557,7 +49744,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -49800,7 +49987,7 @@ paths: parameters: - *324 - *325 - - *169 + - *173 responses: '200': description: Response @@ -49836,7 +50023,7 @@ paths: parameters: - *324 - *325 - - *169 + - *173 requestBody: required: true content: @@ -49864,7 +50051,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -49892,7 +50079,7 @@ paths: parameters: - *324 - *325 - - *169 + - *173 responses: '204': description: Response @@ -49989,7 +50176,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -50016,7 +50203,7 @@ paths: parameters: - *324 - *325 - - *172 + - *176 responses: '200': description: Response @@ -50052,7 +50239,7 @@ paths: parameters: - *324 - *325 - - *172 + - *176 requestBody: required: true content: @@ -50096,7 +50283,7 @@ paths: parameters: - *324 - *325 - - *172 + - *176 responses: '204': description: Response @@ -50703,7 +50890,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 '404': *7 @@ -51346,7 +51533,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *238 + items: *242 apps: description: The list of apps with review dismissal access. @@ -51375,7 +51562,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *238 + items: *242 apps: description: The list of apps allowed to bypass pull request requirements. @@ -51834,12 +52021,12 @@ paths: nullable: true oneOf: - *19 - - *170 + - *174 committer: nullable: true oneOf: - *19 - - *170 + - *174 parents: type: array items: @@ -52617,7 +52804,7 @@ paths: items: *19 teams: type: array - items: *238 + items: *242 apps: type: array items: *6 @@ -52635,7 +52822,7 @@ paths: items: *19 teams: type: array - items: *238 + items: *242 apps: type: array items: *6 @@ -54022,9 +54209,9 @@ paths: application/json: schema: type: array - items: *238 + items: *242 examples: - default: *253 + default: *257 '404': *7 x-github: githubCloudOnly: false @@ -54082,9 +54269,9 @@ paths: application/json: schema: type: array - items: *238 + items: *242 examples: - default: *253 + default: *257 '422': *16 x-github: githubCloudOnly: false @@ -54143,9 +54330,9 @@ paths: application/json: schema: type: array - items: *238 + items: *242 examples: - default: *253 + default: *257 '422': *16 x-github: githubCloudOnly: false @@ -54203,9 +54390,9 @@ paths: application/json: schema: type: array - items: *238 + items: *242 examples: - default: *253 + default: *257 '422': *16 x-github: githubCloudOnly: false @@ -54239,7 +54426,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 '404': *7 x-github: githubCloudOnly: false @@ -54298,7 +54485,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 '422': *16 x-github: githubCloudOnly: false @@ -54358,7 +54545,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 '422': *16 x-github: githubCloudOnly: false @@ -54418,7 +54605,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 '422': *16 x-github: githubCloudOnly: false @@ -54976,8 +55163,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests @@ -55052,8 +55239,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 required: - id - node_id @@ -55752,7 +55939,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -55888,9 +56075,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 - repository: *159 + properties: *107 + required: *108 + repository: *163 created_at: type: string format: date-time @@ -56306,7 +56493,7 @@ paths: required: - app_id - setting - repository: *159 + repository: *163 examples: default: value: @@ -56754,7 +56941,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -56783,8 +56970,8 @@ paths: parameters: - *324 - *325 - - *182 - - *183 + - *186 + - *187 - *20 - *18 - &414 @@ -56820,7 +57007,7 @@ paths: be returned. in: query required: false - schema: *184 + schema: *188 - name: severity description: If specified, only code scanning alerts with this severity will be returned. @@ -56980,7 +57167,7 @@ paths: application/json: schema: *3 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57182,7 +57369,7 @@ paths: '304': *37 '403': *411 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57315,7 +57502,7 @@ paths: application/json: schema: *3 '404': *7 - '503': *96 + '503': *100 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -57390,7 +57577,7 @@ paths: - source '403': *411 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57424,8 +57611,8 @@ paths: parameters: - *324 - *325 - - *182 - - *183 + - *186 + - *187 - *20 - *18 - *415 @@ -57565,7 +57752,7 @@ paths: warning: '' '403': *411 '404': *7 - '503': *96 + '503': *100 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -57669,7 +57856,7 @@ paths: - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 '403': *411 '404': *7 - '503': *96 + '503': *100 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -57805,7 +57992,7 @@ paths: '400': *15 '403': *420 '404': *7 - '503': *96 + '503': *100 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -57947,7 +58134,7 @@ paths: commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c '403': *411 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58023,7 +58210,7 @@ paths: description: Found '403': *411 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58056,7 +58243,7 @@ paths: description: Response '403': *420 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58510,7 +58697,7 @@ paths: content: application/json: schema: *3 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58548,7 +58735,7 @@ paths: examples: default: *425 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58708,7 +58895,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58793,7 +58980,7 @@ paths: schedule: weekly '403': *411 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58858,7 +59045,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -58891,7 +59078,7 @@ paths: content: application/json: schema: *3 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59033,7 +59220,7 @@ paths: '404': *7 '413': description: Payload Too Large if the sarif field is too large - '503': *96 + '503': *100 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -59102,7 +59289,7 @@ paths: '403': *411 '404': description: Not Found if the sarif id does not match any upload - '503': *96 + '503': *100 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -59149,7 +59336,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *187 + configuration: *191 examples: default: value: @@ -59178,7 +59365,7 @@ paths: html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 created_at: '2024-05-01T00:00:00Z' updated_at: '2024-05-01T00:00:00Z' - '204': *190 + '204': *192 '304': *37 '403': *29 '404': *7 @@ -59341,7 +59528,7 @@ paths: type: integer codespaces: type: array - items: *242 + items: *246 examples: default: value: @@ -59703,7 +59890,7 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *242 + schema: *246 examples: default: *429 '202': @@ -59711,14 +59898,14 @@ paths: being retried in the background content: application/json: - schema: *242 + schema: *246 examples: default: *429 '400': *15 '401': *25 '403': *29 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -60021,7 +60208,7 @@ paths: '403': *29 '404': *7 '422': *16 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60135,7 +60322,7 @@ paths: parameters: - *324 - *325 - - *169 + - *173 responses: '200': description: Response @@ -60165,7 +60352,7 @@ paths: parameters: - *324 - *325 - - *169 + - *173 requestBody: required: true content: @@ -60193,7 +60380,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -60219,7 +60406,7 @@ paths: parameters: - *324 - *325 - - *169 + - *173 responses: '204': description: Response @@ -60459,7 +60646,7 @@ paths: parameters: - *324 - *325 - - *181 + - *185 responses: '204': description: Response if user is a collaborator @@ -60503,7 +60690,7 @@ paths: parameters: - *324 - *325 - - *181 + - *185 requestBody: required: false content: @@ -60540,7 +60727,7 @@ paths: example: 42 type: integer format: int64 - repository: *159 + repository: *163 invitee: title: Simple User description: A GitHub user. @@ -60753,7 +60940,7 @@ paths: parameters: - *324 - *325 - - *181 + - *185 responses: '204': description: No Content when collaborator was removed from the repository. @@ -60784,7 +60971,7 @@ paths: parameters: - *324 - *325 - - *181 + - *185 responses: '200': description: if user has admin permissions @@ -60912,8 +61099,8 @@ paths: updated_at: type: string format: date-time - author_association: *105 - reactions: *106 + author_association: *109 + reactions: *110 required: - url - html_url @@ -60990,7 +61177,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 responses: '200': description: Response @@ -61057,7 +61244,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 requestBody: required: true content: @@ -61132,7 +61319,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 responses: '204': description: Response @@ -61155,7 +61342,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. @@ -61206,7 +61393,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 requestBody: required: true content: @@ -61271,7 +61458,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 - *316 responses: '204': @@ -61454,7 +61641,7 @@ paths: '500': *84 '400': *15 '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61523,7 +61710,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *16 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61821,7 +62008,7 @@ paths: nullable: true requested_teams: type: array - items: *238 + items: *242 nullable: true head: type: object @@ -61897,7 +62084,7 @@ paths: - review_comments - review_comment - self - author_association: *105 + author_association: *109 auto_merge: &549 title: Auto merge description: The status of auto merging a pull request. @@ -62441,7 +62628,7 @@ paths: draft: false headers: Link: *39 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62606,8 +62793,8 @@ paths: '422': *16 '404': *7 '500': *84 - '503': *96 - '409': *146 + '503': *100 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62994,7 +63181,7 @@ paths: type: string total_count: type: integer - repository: *159 + repository: *163 commit_url: type: string format: uri @@ -63297,8 +63484,8 @@ paths: title: License Simple description: License Simple type: object - properties: *119 - required: *120 + properties: *123 + required: *124 nullable: true contributing: title: Community Health File @@ -63761,7 +63948,7 @@ paths: module Test" '404': *7 '500': *84 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64819,8 +65006,8 @@ paths: verified_at: '422': *16 '404': *7 - '409': *146 - '503': *96 + '409': *150 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64966,18 +65153,18 @@ paths: parameters: - *324 - *325 - - *200 - - *201 - - *202 - - *203 + - *204 + - *205 + - *206 + - *207 - 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 - - *204 - - *205 + - *208 + - *209 - *78 - name: page description: "**Closing down notice**. Page number of the results to fetch. @@ -64997,8 +65184,8 @@ paths: default: 30 - *76 - *77 - - *206 - - *207 + - *210 + - *211 responses: '200': description: Response @@ -65577,7 +65764,7 @@ paths: '400': *15 '403': *29 '404': *7 - '409': *146 + '409': *150 '422': *8 x-github: githubCloudOnly: false @@ -65703,7 +65890,7 @@ paths: parameters: - *324 - *325 - - *169 + - *173 responses: '200': description: Response @@ -65737,7 +65924,7 @@ paths: parameters: - *324 - *325 - - *169 + - *173 requestBody: required: true content: @@ -65765,7 +65952,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -65791,7 +65978,7 @@ paths: parameters: - *324 - *325 - - *169 + - *173 responses: '204': description: Response @@ -66935,8 +67122,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 required: - id - node_id @@ -67349,7 +67536,7 @@ paths: reviewer: anyOf: - *19 - - *238 + - *242 required: - id - node_id @@ -68379,7 +68566,7 @@ paths: - *324 - *325 - *474 - - *169 + - *173 responses: '200': description: Response @@ -68412,7 +68599,7 @@ paths: - *324 - *325 - *474 - - *169 + - *173 requestBody: required: true content: @@ -68443,7 +68630,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -68472,7 +68659,7 @@ paths: - *324 - *325 - *474 - - *169 + - *173 responses: '204': description: Default response @@ -68571,7 +68758,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -68599,7 +68786,7 @@ paths: - *324 - *325 - *474 - - *172 + - *176 responses: '200': description: Response @@ -68630,7 +68817,7 @@ paths: parameters: - *324 - *325 - - *172 + - *176 - *474 requestBody: required: true @@ -68675,7 +68862,7 @@ paths: parameters: - *324 - *325 - - *172 + - *176 - *474 responses: '204': @@ -68709,7 +68896,7 @@ paths: application/json: schema: type: array - items: *130 + items: *134 examples: 200-response: value: @@ -68799,7 +68986,7 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: default: value: @@ -69044,7 +69231,7 @@ paths: schema: type: string '404': *7 - '409': *146 + '409': *150 '403': *29 '422': description: Validation failed @@ -69052,7 +69239,7 @@ paths: application/json: schema: oneOf: - - *144 + - *148 - *487 x-github: githubCloudOnly: false @@ -69130,7 +69317,7 @@ paths: '404': *7 '422': *16 '403': *29 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69451,7 +69638,7 @@ paths: type: string '422': *16 '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69540,7 +69727,7 @@ paths: payload: verified_at: '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69638,7 +69825,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *39 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69679,7 +69866,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69737,7 +69924,7 @@ paths: schema: type: string '422': *16 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69791,7 +69978,7 @@ paths: examples: default: *491 '422': *16 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69814,7 +70001,7 @@ paths: '204': description: Response '422': *16 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70018,7 +70205,7 @@ paths: schema: type: string '422': *16 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70080,7 +70267,7 @@ paths: examples: default: *494 '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70265,7 +70452,7 @@ paths: '422': *16 '404': *7 '403': *29 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70353,7 +70540,7 @@ paths: truncated: false '422': *16 '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70615,7 +70802,7 @@ paths: parameters: - *324 - *325 - - *215 + - *219 responses: '200': description: Response @@ -70645,7 +70832,7 @@ paths: parameters: - *324 - *325 - - *215 + - *219 requestBody: required: true content: @@ -70715,7 +70902,7 @@ paths: parameters: - *324 - *325 - - *215 + - *219 responses: '204': description: Response @@ -70741,7 +70928,7 @@ paths: parameters: - *324 - *325 - - *215 + - *219 responses: '200': description: Response @@ -70770,7 +70957,7 @@ paths: parameters: - *324 - *325 - - *215 + - *219 requestBody: required: false content: @@ -70816,9 +71003,9 @@ paths: parameters: - *324 - *325 - - *215 + - *219 - *18 - - *216 + - *220 responses: '200': description: Response @@ -70826,9 +71013,9 @@ paths: application/json: schema: type: array - items: *217 + items: *221 examples: - default: *218 + default: *222 '400': *15 '422': *16 x-github: @@ -70849,16 +71036,16 @@ paths: parameters: - *324 - *325 - - *215 + - *219 - *17 responses: '200': description: Response content: application/json: - schema: *219 + schema: *223 examples: - default: *220 + default: *224 '400': *15 '422': *16 x-github: @@ -70879,10 +71066,10 @@ paths: parameters: - *324 - *325 - - *215 + - *219 - *17 responses: - '202': *147 + '202': *151 '400': *15 '422': *16 x-github: @@ -70904,7 +71091,7 @@ paths: parameters: - *324 - *325 - - *215 + - *219 responses: '204': description: Response @@ -70931,7 +71118,7 @@ paths: parameters: - *324 - *325 - - *215 + - *219 responses: '204': description: Response @@ -71721,7 +71908,7 @@ paths: application/json: schema: anyOf: - - *233 + - *237 - type: object properties: {} additionalProperties: false @@ -71769,7 +71956,7 @@ paths: description: Response content: application/json: - schema: *233 + schema: *237 examples: default: *504 '409': @@ -71963,7 +72150,7 @@ paths: parameters: - *324 - *325 - - *237 + - *241 requestBody: required: false content: @@ -72125,7 +72312,7 @@ paths: parameters: - *324 - *325 - - *237 + - *241 responses: '204': description: Response @@ -72197,7 +72384,7 @@ paths: required: false schema: type: string - - *239 + - *243 - name: sort description: What to sort results by. in: query @@ -72210,7 +72397,7 @@ paths: - comments default: created - *78 - - *108 + - *112 - *18 - *20 responses: @@ -72220,7 +72407,7 @@ paths: application/json: schema: type: array - items: *118 + items: *122 examples: default: &516 value: @@ -72475,7 +72662,7 @@ paths: description: Response content: application/json: - schema: *118 + schema: *122 examples: default: &511 value: @@ -72631,7 +72818,7 @@ paths: '400': *15 '403': *29 '422': *16 - '503': *96 + '503': *100 '404': *7 '410': *335 x-github: @@ -72663,7 +72850,7 @@ paths: parameters: - *324 - *325 - - *128 + - *132 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -72673,7 +72860,7 @@ paths: enum: - asc - desc - - *108 + - *112 - *18 - *20 responses: @@ -72745,7 +72932,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 responses: '200': description: Response @@ -72809,7 +72996,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 requestBody: required: true content: @@ -72853,7 +73040,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 responses: '204': description: Response @@ -72875,7 +73062,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. @@ -72926,7 +73113,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 requestBody: required: true content: @@ -72991,7 +73178,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 - *316 responses: '204': @@ -73111,7 +73298,7 @@ paths: properties: *4 required: *5 nullable: true - requested_team: *238 + requested_team: *242 dismissed_review: title: Issue Event Dismissed Review type: object @@ -73176,7 +73363,7 @@ paths: required: - from - to - author_association: *105 + author_association: *109 lock_reason: type: string nullable: true @@ -73189,8 +73376,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 required: - id - node_id @@ -73627,7 +73814,7 @@ paths: description: Response content: application/json: - schema: *118 + schema: *122 examples: default: *511 '301': *338 @@ -73754,11 +73941,11 @@ paths: description: Response content: application/json: - schema: *118 + schema: *122 examples: default: *511 '422': *16 - '503': *96 + '503': *100 '403': *29 '301': *338 '404': *7 @@ -73808,7 +73995,7 @@ paths: description: Response content: application/json: - schema: *118 + schema: *122 examples: default: *511 x-github: @@ -73853,7 +74040,7 @@ paths: description: Response content: application/json: - schema: *118 + schema: *122 examples: default: *511 x-github: @@ -73922,7 +74109,7 @@ paths: - *324 - *325 - *512 - - *108 + - *112 - *18 - *20 responses: @@ -74067,8 +74254,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 label: type: object properties: @@ -74121,8 +74308,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 label: type: object properties: @@ -74210,8 +74397,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 assignee: *19 assigner: *19 required: @@ -74257,8 +74444,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 milestone: type: object properties: @@ -74308,8 +74495,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 milestone: type: object properties: @@ -74359,8 +74546,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 rename: type: object properties: @@ -74413,10 +74600,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 review_requester: *19 - requested_team: *238 + requested_team: *242 requested_reviewer: *19 required: - review_requester @@ -74460,10 +74647,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 review_requester: *19 - requested_team: *238 + requested_team: *242 requested_reviewer: *19 required: - review_requester @@ -74507,8 +74694,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 dismissed_review: type: object properties: @@ -74567,8 +74754,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 lock_reason: type: string example: '"off-topic"' @@ -74615,8 +74802,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 project_card: type: object properties: @@ -74681,8 +74868,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 project_card: type: object properties: @@ -74747,8 +74934,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 project_card: type: object properties: @@ -75473,7 +75660,7 @@ paths: description: Response content: application/json: - schema: *118 + schema: *122 examples: default: *511 headers: @@ -75520,7 +75707,7 @@ paths: application/json: schema: type: array - items: *118 + items: *122 examples: default: *516 headers: @@ -75582,7 +75769,7 @@ paths: description: Response content: application/json: - schema: *118 + schema: *122 examples: default: *511 headers: @@ -75644,13 +75831,13 @@ paths: description: Response content: application/json: - schema: *118 + schema: *122 examples: default: *511 '403': *29 '404': *7 '422': *8 - '503': *96 + '503': *100 x-github: triggersNotification: true githubCloudOnly: false @@ -75740,7 +75927,7 @@ paths: issue_url: type: string format: uri - author_association: *105 + author_association: *109 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -75750,9 +75937,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 - reactions: *106 + properties: *107 + required: *108 + reactions: *110 required: - event - actor @@ -75783,7 +75970,7 @@ paths: properties: type: type: string - issue: *118 + issue: *122 required: - event - created_at @@ -75978,7 +76165,7 @@ paths: type: string body_text: type: string - author_association: *105 + author_association: *109 required: - event - id @@ -76090,7 +76277,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *105 + author_association: *109 _links: type: object properties: @@ -76174,7 +76361,7 @@ paths: enum: - line - file - reactions: *106 + reactions: *110 body_html: type: string example: '"

comment body

"' @@ -76241,8 +76428,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 assignee: *19 required: - id @@ -76285,8 +76472,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 assignee: *19 required: - id @@ -76329,8 +76516,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 state_reason: type: string nullable: true @@ -76990,7 +77177,7 @@ paths: - *324 - *325 responses: - '202': *147 + '202': *151 '403': description: |- We will return a 403 with one of the following messages: @@ -77107,8 +77294,8 @@ paths: title: License Simple description: License Simple type: object - properties: *119 - required: *120 + properties: *123 + required: *124 nullable: true required: - _links @@ -77674,7 +77861,7 @@ paths: - *325 - *538 - *539 - - *108 + - *112 - *540 - *18 - *20 @@ -77685,7 +77872,7 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: default: *541 headers: @@ -78002,7 +78189,7 @@ paths: examples: default: *543 '422': *16 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78110,7 +78297,7 @@ paths: description: Response '422': *16 '400': *15 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78138,7 +78325,7 @@ paths: description: Response '422': *16 '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78571,7 +78758,7 @@ paths: - *325 - *546 responses: - '204': *190 + '204': *192 '404': *7 x-github: githubCloudOnly: false @@ -78828,7 +79015,7 @@ paths: description: Empty response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -78896,7 +79083,7 @@ paths: - *324 - *325 responses: - '204': *190 + '204': *192 '422': *15 x-github: githubCloudOnly: false @@ -78918,7 +79105,7 @@ paths: - *324 - *325 responses: - '204': *190 + '204': *192 '422': *15 x-github: githubCloudOnly: false @@ -78961,7 +79148,7 @@ paths: application/json: schema: type: array - items: *267 + items: *271 examples: default: value: @@ -79048,7 +79235,7 @@ paths: description: Response content: application/json: - schema: *267 + schema: *271 examples: default: *334 '401': *25 @@ -79551,7 +79738,7 @@ paths: - review_comments - review_comment - self - author_association: *105 + author_association: *109 auto_merge: *549 draft: description: Indicates whether or not the pull request is a draft. @@ -80191,7 +80378,7 @@ paths: enum: - asc - desc - - *108 + - *112 - *18 - *20 responses: @@ -80282,7 +80469,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 responses: '200': description: Response @@ -80367,7 +80554,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 requestBody: required: true content: @@ -80409,7 +80596,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 responses: '204': description: Response @@ -80432,7 +80619,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. @@ -80483,7 +80670,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 requestBody: required: true content: @@ -80548,7 +80735,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 - *316 responses: '204': @@ -80618,7 +80805,7 @@ paths: application/json: schema: *3 '500': *84 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80774,7 +80961,7 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *242 + schema: *246 examples: default: *429 '202': @@ -80782,13 +80969,13 @@ paths: being retried in the background content: application/json: - schema: *242 + schema: *246 examples: default: *429 '401': *25 '403': *29 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -80817,7 +81004,7 @@ paths: - *324 - *325 - *554 - - *128 + - *132 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -80827,7 +81014,7 @@ paths: enum: - asc - desc - - *108 + - *112 - *18 - *20 responses: @@ -81070,7 +81257,7 @@ paths: - *324 - *325 - *554 - - *117 + - *121 requestBody: required: true content: @@ -81253,7 +81440,7 @@ paths: Link: *39 '422': *16 '500': *84 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81428,7 +81615,7 @@ paths: items: *19 teams: type: array - items: *238 + items: *242 required: - users - teams @@ -82684,7 +82871,7 @@ paths: type: string body_text: type: string - author_association: *105 + author_association: *109 required: - id - node_id @@ -83203,7 +83390,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *105 + author_association: *109 _links: type: object properties: @@ -83218,7 +83405,7 @@ paths: type: string body_html: type: string - reactions: *106 + reactions: *110 side: description: The side of the first line of the range for a multi-line comment. @@ -83821,7 +84008,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *106 + reactions: *110 required: - assets_url - upload_url @@ -85617,7 +85804,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85677,7 +85864,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85779,7 +85966,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *96 + '503': *100 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -86151,7 +86338,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86229,7 +86416,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *96 + '503': *100 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -86255,7 +86442,7 @@ paths: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *96 + '503': *100 '200': description: Response content: @@ -86275,18 +86462,20 @@ paths: description: The type of scan status: type: string - description: The state of the scan. Either "completed" or - "running" + description: The state of the scan. Either "completed", + "running", or "pending" completed_at: type: string format: date-time description: The time that the scan was completed. Empty - if the scan is active + if the scan is running nullable: true started_at: type: string format: date-time - description: The time that the scan was started + description: The time that the scan was started. Empty if + the scan is pending + nullable: true pattern_update_scans: type: array items: *605 @@ -87290,7 +87479,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *144 + schema: *148 examples: invalid_state_transition: value: @@ -87325,7 +87514,7 @@ paths: - *325 - *608 responses: - '202': *147 + '202': *151 '400': *15 '403': *29 '404': *7 @@ -87508,8 +87697,8 @@ paths: - - 1302998400 - 1124 - -435 - '202': *147 - '204': *190 + '202': *151 + '204': *192 '422': description: Repository contains more than 10,000 commits x-github: @@ -87578,8 +87767,8 @@ paths: - 0 total: 89 week: 1336280400 - '202': *147 - '204': *190 + '202': *151 + '204': *192 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87680,8 +87869,8 @@ paths: a: 6898 d: 77 c: 10 - '202': *147 - '204': *190 + '202': *151 + '204': *192 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87882,7 +88071,7 @@ paths: - - 0 - 2 - 21 - '204': *190 + '204': *192 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88024,7 +88213,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 x-github: @@ -88476,9 +88665,9 @@ paths: application/json: schema: type: array - items: *238 + items: *242 examples: - default: *253 + default: *257 headers: Link: *39 '404': *7 @@ -89002,7 +89191,7 @@ paths: description: Response content: application/json: - schema: *159 + schema: *163 examples: default: value: @@ -89450,7 +89639,7 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: default: value: @@ -90786,7 +90975,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities parameters: - - *141 + - *145 - name: startIndex description: 'Used for pagination: the index of the first result to return.' in: query @@ -91106,7 +91295,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user parameters: - - *141 + - *145 responses: '201': description: Response @@ -91239,7 +91428,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - - *141 + - *145 - *636 responses: '200': @@ -91273,7 +91462,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - - *141 + - *145 - *636 responses: '200': @@ -91393,7 +91582,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - - *141 + - *145 - *636 responses: '200': @@ -91496,7 +91685,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - - *141 + - *145 - *636 responses: '204': @@ -91617,7 +91806,7 @@ paths: html_url: type: string format: uri - repository: *159 + repository: *163 score: type: number file_size: @@ -91749,7 +91938,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *96 + '503': *100 '422': *16 '403': *29 x-github: @@ -91921,7 +92110,7 @@ paths: type: string sha: type: string - repository: *159 + repository: *163 score: type: number node_id: @@ -92286,7 +92475,7 @@ paths: type: string score: type: number - author_association: *105 + author_association: *109 draft: type: boolean repository: *57 @@ -92306,9 +92495,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 - reactions: *106 + properties: *107 + required: *108 + reactions: *110 required: - assignee - closed_at @@ -92424,7 +92613,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *96 + '503': *100 '422': *16 '304': *37 '403': *29 @@ -92826,8 +93015,8 @@ paths: title: License Simple description: License Simple type: object - properties: *119 - required: *120 + properties: *123 + required: *124 nullable: true permissions: type: object @@ -93048,7 +93237,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *96 + '503': *100 '422': *16 '304': *37 x-github: @@ -93503,7 +93692,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *96 + '503': *100 '422': *16 x-github: githubCloudOnly: false @@ -94375,9 +94564,9 @@ paths: application/json: schema: type: array - items: *235 + items: *239 examples: - default: *236 + default: *240 headers: Link: *39 x-github: @@ -94426,7 +94615,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 '404': *7 @@ -94455,7 +94644,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - *646 - - *181 + - *185 responses: '204': description: if user is a member @@ -94492,7 +94681,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - *646 - - *181 + - *185 responses: '204': description: Response @@ -94532,7 +94721,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - *646 - - *181 + - *185 responses: '204': description: Response @@ -94569,7 +94758,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy parameters: - *646 - - *181 + - *185 responses: '200': description: Response @@ -94611,7 +94800,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - *646 - - *181 + - *185 requestBody: required: false content: @@ -94673,7 +94862,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - *646 - - *181 + - *185 responses: '204': description: Response @@ -94882,9 +95071,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: *260 + default: *264 headers: Link: *39 '404': *7 @@ -95289,7 +95478,7 @@ paths: application/json: schema: type: array - items: *238 + items: *242 examples: response-if-child-teams-exist: *656 headers: @@ -95759,7 +95948,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 '304': *37 '404': *7 '403': *29 @@ -95782,7 +95971,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *181 + - *185 responses: '204': description: If the user is blocked @@ -95810,7 +95999,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user parameters: - - *181 + - *185 responses: '204': description: Response @@ -95834,7 +96023,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user parameters: - - *181 + - *185 responses: '204': description: Response @@ -95883,9 +96072,9 @@ paths: type: integer codespaces: type: array - items: *242 + items: *246 examples: - default: *243 + default: *247 '304': *37 '500': *84 '401': *25 @@ -96024,7 +96213,7 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *242 + schema: *246 examples: default: *429 '202': @@ -96032,13 +96221,13 @@ paths: being retried in the background content: application/json: - schema: *242 + schema: *246 examples: default: *429 '401': *25 '403': *29 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96188,7 +96377,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *169 + - *173 responses: '200': description: Response @@ -96224,7 +96413,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *169 + - *173 requestBody: required: true content: @@ -96269,7 +96458,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -96297,7 +96486,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *169 + - *173 responses: '204': description: Response @@ -96322,7 +96511,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *169 + - *173 responses: '200': description: Response @@ -96338,7 +96527,7 @@ paths: type: integer repositories: type: array - items: *159 + items: *163 examples: default: *660 '401': *25 @@ -96365,7 +96554,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *169 + - *173 requestBody: required: true content: @@ -96419,7 +96608,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *169 + - *173 - name: repository_id in: path required: true @@ -96452,7 +96641,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *169 + - *173 - name: repository_id in: path required: true @@ -96484,13 +96673,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *244 + - *248 responses: '200': description: Response content: application/json: - schema: *242 + schema: *246 examples: default: *429 '304': *37 @@ -96518,7 +96707,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *244 + - *248 requestBody: required: false content: @@ -96548,7 +96737,7 @@ paths: description: Response content: application/json: - schema: *242 + schema: *246 examples: default: *429 '401': *25 @@ -96572,9 +96761,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *244 + - *248 responses: - '202': *147 + '202': *151 '304': *37 '500': *84 '401': *25 @@ -96601,7 +96790,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *244 + - *248 responses: '202': description: Response @@ -96680,7 +96869,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *244 + - *248 - name: export_id in: path required: true @@ -96716,7 +96905,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *244 + - *248 responses: '200': description: Response @@ -96763,7 +96952,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *244 + - *248 requestBody: required: true content: @@ -97593,13 +97782,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *244 + - *248 responses: '200': description: Response content: application/json: - schema: *242 + schema: *246 examples: default: *429 '304': *37 @@ -97613,7 +97802,7 @@ paths: schema: *3 '403': *29 '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97633,13 +97822,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *244 + - *248 responses: '200': description: Response content: application/json: - schema: *242 + schema: *246 examples: default: *429 '500': *84 @@ -97671,7 +97860,7 @@ paths: application/json: schema: type: array - items: *254 + items: *258 examples: default: &677 value: @@ -98026,7 +98215,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 '304': *37 @@ -98059,7 +98248,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 '304': *37 @@ -98081,7 +98270,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *181 + - *185 responses: '204': description: if the person is followed by the authenticated user @@ -98111,7 +98300,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user parameters: - - *181 + - *185 responses: '204': description: Response @@ -98136,7 +98325,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user parameters: - - *181 + - *185 responses: '204': description: Response @@ -98700,7 +98889,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *154 + - *158 responses: '204': description: Response @@ -98726,7 +98915,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *154 + - *158 responses: '204': description: Response @@ -98760,12 +98949,12 @@ paths: application/json: schema: anyOf: - - *233 + - *237 - type: object properties: {} additionalProperties: false examples: - default: *234 + default: *238 '204': description: Response when there are no restrictions x-github: @@ -98800,7 +98989,7 @@ paths: description: Response content: application/json: - schema: *233 + schema: *237 examples: default: value: @@ -98881,7 +99070,7 @@ paths: - closed - all default: open - - *239 + - *243 - name: sort description: What to sort results by. in: query @@ -98894,7 +99083,7 @@ paths: - comments default: created - *78 - - *108 + - *112 - *18 - *20 responses: @@ -98904,9 +99093,9 @@ paths: application/json: schema: type: array - items: *118 + items: *122 examples: - default: *240 + default: *244 headers: Link: *39 '404': *7 @@ -99192,7 +99381,7 @@ paths: - id - type - login - plan: *122 + plan: *126 required: - billing_cycle - next_billing_date @@ -99307,7 +99496,7 @@ paths: application/json: schema: type: array - items: *245 + items: *249 examples: default: value: @@ -99409,13 +99598,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *141 + - *145 responses: '200': description: Response content: application/json: - schema: *245 + schema: *249 examples: default: value: @@ -99473,7 +99662,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *141 + - *145 requestBody: required: true content: @@ -99498,7 +99687,7 @@ paths: description: Response content: application/json: - schema: *245 + schema: *249 examples: default: value: @@ -99566,7 +99755,7 @@ paths: application/json: schema: type: array - items: *247 + items: *251 examples: default: value: @@ -99819,7 +100008,7 @@ paths: description: Response content: application/json: - schema: *247 + schema: *251 examples: default: value: @@ -99999,7 +100188,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *248 + - *252 - name: exclude in: query required: false @@ -100012,7 +100201,7 @@ paths: description: Response content: application/json: - schema: *247 + schema: *251 examples: default: value: @@ -100206,7 +100395,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *248 + - *252 responses: '302': description: Response @@ -100232,7 +100421,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *248 + - *252 responses: '204': description: Response @@ -100261,7 +100450,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *248 + - *252 - *674 responses: '204': @@ -100286,7 +100475,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *248 + - *252 - *18 - *20 responses: @@ -100296,9 +100485,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: *260 + default: *264 headers: Link: *39 '404': *7 @@ -100387,7 +100576,7 @@ paths: application/json: schema: type: array - items: *254 + items: *258 examples: default: *677 '400': *678 @@ -100410,14 +100599,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *256 - - *257 + - *260 + - *261 responses: '200': description: Response content: application/json: - schema: *254 + schema: *258 examples: default: &691 value: @@ -100532,8 +100721,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *256 - - *257 + - *260 + - *261 responses: '204': description: Response @@ -100563,8 +100752,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *256 - - *257 + - *260 + - *261 - name: token description: package token schema: @@ -100596,8 +100785,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *256 - - *257 + - *260 + - *261 - *20 - *18 - name: state @@ -100617,7 +100806,7 @@ paths: application/json: schema: type: array - items: *258 + items: *262 examples: default: value: @@ -100666,15 +100855,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *256 - - *257 - - *259 + - *260 + - *261 + - *263 responses: '200': description: Response content: application/json: - schema: *258 + schema: *262 examples: default: value: @@ -100710,9 +100899,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *256 - - *257 - - *259 + - *260 + - *261 + - *263 responses: '204': description: Response @@ -100742,9 +100931,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *256 - - *257 - - *259 + - *260 + - *261 + - *263 responses: '204': description: Response @@ -100800,7 +100989,7 @@ paths: description: Response content: application/json: - schema: *267 + schema: *271 examples: default: value: @@ -101351,12 +101540,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *237 + - *241 responses: '204': description: Response '403': *29 - '409': *146 + '409': *150 '404': *7 '304': *37 x-github: @@ -101374,11 +101563,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *237 + - *241 responses: '204': description: Response - '409': *146 + '409': *150 '304': *37 '404': *7 '403': *29 @@ -102031,9 +102220,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: *260 + default: *264 headers: Link: *39 '304': *37 @@ -102146,7 +102335,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *124 + - *128 responses: '200': description: Response @@ -102263,7 +102452,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: example: ; rel="next" @@ -102291,7 +102480,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user parameters: - - *181 + - *185 responses: '200': description: Response @@ -102329,7 +102518,7 @@ paths: - *18 - *76 - *77 - - *181 + - *185 - name: subject_digest description: Subject Digest in: path @@ -102429,7 +102618,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -102455,7 +102644,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *181 + - *185 responses: '200': description: Response @@ -102463,7 +102652,7 @@ paths: application/json: schema: type: array - items: *254 + items: *258 examples: default: *677 '403': *29 @@ -102488,7 +102677,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -102498,7 +102687,7 @@ paths: application/json: schema: type: array - items: *130 + items: *134 examples: default: value: @@ -102569,8 +102758,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *181 - - *141 + - *185 + - *145 - *18 - *20 responses: @@ -102580,7 +102769,7 @@ paths: application/json: schema: type: array - items: *130 + items: *134 examples: default: value: @@ -102659,7 +102848,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -102669,7 +102858,7 @@ paths: application/json: schema: type: array - items: *130 + items: *134 examples: default: value: @@ -102736,7 +102925,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -102748,7 +102937,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 x-github: @@ -102767,7 +102956,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows parameters: - - *181 + - *185 - *18 - *20 responses: @@ -102779,7 +102968,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 x-github: @@ -102798,7 +102987,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-user-follows-another-user parameters: - - *181 + - *185 - name: target_user in: path required: true @@ -102825,8 +103014,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - - *181 - - *108 + - *185 + - *112 - *18 - *20 responses: @@ -102836,9 +103025,9 @@ paths: application/json: schema: type: array - items: *109 + items: *113 examples: - default: *110 + default: *114 headers: Link: *39 '422': *16 @@ -102859,7 +103048,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -102895,7 +103084,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user parameters: - - *181 + - *185 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -102967,7 +103156,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *181 + - *185 responses: '200': description: Response @@ -102993,7 +103182,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -103041,7 +103230,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -103093,7 +103282,7 @@ paths: - nuget - container - *676 - - *181 + - *185 - *20 - *18 responses: @@ -103103,7 +103292,7 @@ paths: application/json: schema: type: array - items: *254 + items: *258 examples: default: *677 '403': *29 @@ -103128,15 +103317,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *256 - - *257 - - *181 + - *260 + - *261 + - *185 responses: '200': description: Response content: application/json: - schema: *254 + schema: *258 examples: default: *691 x-github: @@ -103159,9 +103348,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *256 - - *257 - - *181 + - *260 + - *261 + - *185 responses: '204': description: Response @@ -103193,9 +103382,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *256 - - *257 - - *181 + - *260 + - *261 + - *185 - name: token description: package token schema: @@ -103227,9 +103416,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *256 - - *257 - - *181 + - *260 + - *261 + - *185 responses: '200': description: Response @@ -103237,7 +103426,7 @@ paths: application/json: schema: type: array - items: *258 + items: *262 examples: default: value: @@ -103295,16 +103484,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-a-user parameters: - - *256 - - *257 - - *259 - - *181 + - *260 + - *261 + - *263 + - *185 responses: '200': description: Response content: application/json: - schema: *258 + schema: *262 examples: default: value: @@ -103339,10 +103528,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *256 - - *257 - - *181 - - *259 + - *260 + - *261 + - *185 + - *263 responses: '204': description: Response @@ -103374,10 +103563,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *256 - - *257 - - *181 - - *259 + - *260 + - *261 + - *185 + - *263 responses: '204': description: Response @@ -103400,7 +103589,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-user-projects parameters: - - *181 + - *185 - name: state description: Indicates the state of the projects to return. in: query @@ -103421,7 +103610,7 @@ paths: application/json: schema: type: array - items: *267 + items: *271 examples: default: value: @@ -103480,7 +103669,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -103490,7 +103679,7 @@ paths: application/json: schema: type: array - items: *130 + items: *134 examples: default: value: @@ -103569,7 +103758,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-received-by-a-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -103579,7 +103768,7 @@ paths: application/json: schema: type: array - items: *130 + items: *134 examples: default: value: @@ -103656,7 +103845,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user parameters: - - *181 + - *185 - name: type description: Limit results to repositories of the specified type. in: query @@ -103699,9 +103888,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: *260 + default: *264 headers: Link: *39 x-github: @@ -103725,7 +103914,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *181 + - *185 responses: '200': description: Response @@ -103755,7 +103944,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *181 + - *185 responses: '200': description: Response @@ -103785,7 +103974,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *181 + - *185 responses: '200': description: Response @@ -103811,7 +104000,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -103843,7 +104032,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -103879,7 +104068,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *181 + - *185 - *693 - *78 - *18 @@ -103915,7 +104104,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -103925,9 +104114,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: *260 + default: *264 headers: Link: *39 x-github: @@ -104218,8 +104407,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *119 - required: *120 + properties: *123 + required: *124 nullable: true organization: title: Simple User @@ -106571,8 +106760,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 check_suite: description: A suite of checks performed on the code of a given code change @@ -106621,7 +106810,7 @@ x-webhooks: pull_requests: type: array items: *394 - repository: *159 + repository: *163 status: example: completed type: string @@ -112432,7 +112621,7 @@ x-webhooks: type: string enum: - created - definition: *268 + definition: *96 enterprise: *695 installation: *696 organization: *697 @@ -112599,7 +112788,7 @@ x-webhooks: type: string enum: - updated - definition: *268 + definition: *96 enterprise: *695 installation: *696 organization: *697 @@ -123228,8 +123417,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 reactions: title: Reactions type: object @@ -218109,12 +218298,12 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *118 + parent_issue: *122 parent_issue_repo: *57 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *118 + sub_issue: *122 installation: *696 organization: *697 repository: *698 @@ -218201,12 +218390,12 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *118 + parent_issue: *122 parent_issue_repo: *57 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *118 + sub_issue: *122 installation: *696 organization: *697 repository: *698 @@ -218293,12 +218482,12 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *118 + sub_issue: *122 sub_issue_repo: *57 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *118 + parent_issue: *122 installation: *696 organization: *697 repository: *698 @@ -218385,12 +218574,12 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *118 + sub_issue: *122 sub_issue_repo: *57 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *118 + parent_issue: *122 installation: *696 organization: *697 repository: *698 diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index cef2aedaf..89e1db9ad 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -29009,6 +29009,1059 @@ } } }, + "/enterprises/{enterprise}/properties/schema": { + "get": { + "summary": "Get custom properties for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets all custom properties defined for an enterprise.\nEnterprise members can read these properties.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/get-enterprise-custom-properties", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-custom-properties-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + }, + "patch": { + "summary": "Create or update custom properties for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates new or updates existing custom properties defined for an enterprise in a batch.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/create-or-update-enterprise-custom-properties", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-custom-properties-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "The array of custom properties to create or update.", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "minItems": 1, + "maxItems": 100 + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + } + }, + "/enterprises/{enterprise}/properties/schema/{custom_property_name}": { + "get": { + "summary": "Get a custom property for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a custom property that is defined for an enterprise.\nEnterprise members can read these properties.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/get-enterprise-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + }, + "put": { + "summary": "Create or update a custom property for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new or updates an existing custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/create-or-update-enterprise-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + }, + "delete": { + "summary": "Remove a custom property for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemove a custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/remove-enterprise-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "A header with no content is returned." + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + } + }, "/enterprises/{enterprise}/secret-scanning/alerts": { "get": { "summary": "List secret scanning alerts for an enterprise", @@ -31864,7 +32917,7 @@ "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { "get": { "summary": "Get Copilot metrics for an enterprise team", - "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nUse this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -32513,7 +33566,7 @@ "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for an enterprise team", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -83152,7 +84205,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\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 \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\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" ], @@ -83350,7 +84403,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\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" ], @@ -83550,7 +84603,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\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 \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\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" ], @@ -83748,7 +84801,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\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" ], @@ -419881,18 +420934,19 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active", + "description": "The time that the scan was completed. Empty if the scan is running", "nullable": true }, "started_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true } } } @@ -419909,18 +420963,19 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active", + "description": "The time that the scan was completed. Empty if the scan is running", "nullable": true }, "started_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true } } } @@ -419937,18 +420992,19 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active", + "description": "The time that the scan was completed. Empty if the scan is running", "nullable": true }, "started_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true } } } @@ -419967,18 +421023,19 @@ }, "status": { "type": "string", - "description": "The state of the scan. Either \"completed\" or \"running\"" + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" }, "completed_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was completed. Empty if the scan is active", + "description": "The time that the scan was completed. Empty if the scan is running", "nullable": true }, "started_at": { "type": "string", "format": "date-time", - "description": "The time that the scan was started" + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true } } }, diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 5278c1989..5aeced821 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -979,7 +979,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &145 + schema: &149 title: Validation Error Simple description: Validation Error Simple type: object @@ -1130,7 +1130,7 @@ paths: GitHub. type: object nullable: true - properties: &103 + properties: &107 id: description: Unique identifier of the GitHub app example: 37 @@ -1219,7 +1219,7 @@ paths: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' - required: &104 + required: &108 - id - node_id - owner @@ -1524,7 +1524,7 @@ paths: schema: type: integer default: 30 - - &216 + - &220 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 @@ -1540,7 +1540,7 @@ paths: application/json: schema: type: array - items: &217 + items: &221 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1617,7 +1617,7 @@ paths: - installation_id - repository_id examples: - default: &218 + default: &222 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1676,7 +1676,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &144 + schema: &148 title: Validation Error description: Validation Error type: object @@ -1745,7 +1745,7 @@ paths: description: Response content: application/json: - schema: &219 + schema: &223 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1859,7 +1859,7 @@ paths: - request - response examples: - default: &220 + default: &224 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1919,7 +1919,7 @@ paths: parameters: - *17 responses: - '202': &147 + '202': &151 description: Accepted content: application/json: @@ -2114,7 +2114,7 @@ paths: parameters: - *18 - *20 - - &108 + - &112 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) @@ -2860,7 +2860,7 @@ paths: title: License Simple description: License Simple type: object - properties: &119 + properties: &123 key: type: string example: mit @@ -2882,7 +2882,7 @@ paths: html_url: type: string format: uri - required: &120 + required: &124 - key - name - url @@ -7282,7 +7282,7 @@ paths: description: Response content: application/json: - schema: &148 + schema: &152 type: object properties: total_active_caches_count: @@ -7297,7 +7297,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &149 + default: &153 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7391,7 +7391,7 @@ paths: - all - local_only - selected - selected_actions_url: &152 + selected_actions_url: &156 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` @@ -7759,7 +7759,7 @@ paths: description: Success response content: application/json: - schema: &155 + schema: &159 type: object properties: default_workflow_permissions: &46 @@ -7807,7 +7807,7 @@ paths: required: true content: application/json: - schema: &156 + schema: &160 type: object properties: default_workflow_permissions: *46 @@ -8628,7 +8628,7 @@ paths: application/json: schema: type: array - items: &160 + items: &164 title: Runner Application description: Runner Application type: object @@ -8653,7 +8653,7 @@ paths: - download_url - filename examples: - default: &161 + default: &165 value: - os: osx architecture: x64 @@ -8737,7 +8737,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &162 + '201': &166 description: Response content: application/json: @@ -8847,7 +8847,7 @@ paths: - token - expires_at examples: - default: &163 + default: &167 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -8887,7 +8887,7 @@ paths: application/json: schema: *58 examples: - default: &164 + default: &168 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -8919,7 +8919,7 @@ paths: application/json: schema: *55 examples: - default: &165 + default: &169 value: id: 23 name: MBP @@ -9133,7 +9133,7 @@ paths: - *40 - *54 responses: - '200': &166 + '200': &170 description: Response content: application/json: @@ -9189,7 +9189,7 @@ paths: parameters: - *40 - *54 - - &167 + - &171 name: name description: The name of a self-hosted runner's custom label. in: path @@ -9280,7 +9280,7 @@ paths: required: true content: application/json: - schema: &174 + schema: &178 title: Enterprise Announcement description: Enterprise global announcement type: object @@ -9351,7 +9351,7 @@ paths: required: false schema: type: string - - &175 + - &179 name: include description: |- The event types to include: @@ -9369,7 +9369,7 @@ paths: - web - git - all - - &176 + - &180 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. @@ -9377,7 +9377,7 @@ paths: required: false schema: type: string - - &177 + - &181 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. @@ -9385,7 +9385,7 @@ paths: required: false schema: type: string - - &178 + - &182 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -9407,7 +9407,7 @@ paths: application/json: schema: type: array - items: &179 + items: &183 type: object properties: "@timestamp": @@ -9529,7 +9529,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &180 + default: &184 value: - "@timestamp": 1606929874512 action: team.add_member @@ -10091,7 +10091,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *40 - - &182 + - &186 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, @@ -10101,7 +10101,7 @@ paths: schema: &79 type: string description: The name of the tool used to generate the code scanning analysis. - - &183 + - &187 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -10124,7 +10124,7 @@ paths: be returned. in: query required: false - schema: &184 + schema: &188 type: string description: State of a code scanning alert. enum: @@ -10149,7 +10149,7 @@ paths: application/json: schema: type: array - items: &185 + items: &189 type: object properties: number: &85 @@ -10648,7 +10648,7 @@ paths: - most_recent_instance - repository examples: - default: &186 + default: &190 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -10879,7 +10879,7 @@ paths: headers: Link: *39 '404': *7 - '503': &96 + '503': &100 description: Service unavailable content: application/json: @@ -11288,7 +11288,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &192 + items: &196 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -11306,7 +11306,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &238 + - &242 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -11365,7 +11365,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &251 + properties: &255 id: description: Unique identifier of the team type: integer @@ -11421,7 +11421,7 @@ paths: maps to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string - required: &252 + required: &256 - id - node_id - url @@ -11532,7 +11532,7 @@ paths: - created_at additionalProperties: false examples: - default: &193 + default: &197 value: total_seats: 2 seats: @@ -11667,7 +11667,7 @@ paths: application/json: schema: type: array - items: &98 + items: &102 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -11975,7 +11975,7 @@ paths: - date additionalProperties: true examples: - default: &99 + default: &103 value: - date: '2024-06-24' total_active_users: 24 @@ -12077,7 +12077,7 @@ paths: '500': *84 '403': *29 '404': *7 - '422': &100 + '422': &104 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -12147,7 +12147,7 @@ paths: application/json: schema: type: array - items: &101 + items: &105 title: Copilot Usage Metrics description: Summary of Copilot usage. type: object @@ -12326,7 +12326,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &200 + - &204 name: state in: query description: |- @@ -12335,7 +12335,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &201 + - &205 name: severity in: query description: |- @@ -12344,7 +12344,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &202 + - &206 name: ecosystem in: query description: |- @@ -12353,14 +12353,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &203 + - &207 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 - - &204 + - &208 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -12370,7 +12370,7 @@ paths: enum: - development - runtime - - &205 + - &209 name: sort in: query description: |- @@ -12386,7 +12386,7 @@ paths: - *78 - *76 - *77 - - &206 + - &210 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -12399,7 +12399,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &207 + - &211 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -12419,7 +12419,7 @@ paths: application/json: schema: type: array - items: &208 + items: &212 type: object description: A Dependabot alert. properties: @@ -12726,7 +12726,7 @@ paths: - repository additionalProperties: false examples: - default: &209 + default: &213 value: - number: 2 state: dismissed @@ -13118,6 +13118,303 @@ paths: previews: [] category: enterprise-admin subcategory: license + "/enterprises/{enterprise}/properties/schema": + get: + summary: Get custom properties for an enterprise + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets all custom properties defined for an enterprise. + Enterprise members can read these properties. + tags: + - enterprise-admin + operationId: enterprise-admin/get-enterprise-custom-properties + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-custom-properties-for-an-enterprise + parameters: + - *40 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: &96 + title: Organization Custom Property + description: Custom property defined on an organization + type: object + properties: + property_name: + type: string + description: The name of the property + url: + type: string + format: uri + description: The URL that can be used to fetch, update, or delete + info about this property via the API. + source_type: + type: string + description: The source type of the property + enum: + - organization + - enterprise + example: organization + value_type: + type: string + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + nullable: true + description: Default value of the property + description: + type: string + nullable: true + description: Short description of the property + allowed_values: + type: array + items: + type: string + maxLength: 75 + maxItems: 200 + nullable: true + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + values_editable_by: + type: string + nullable: true + enum: + - org_actors + - org_and_repo_actors + example: org_actors + description: Who can edit the values of the property + required: + - property_name + - value_type + examples: + default: &97 + value: + - property_name: environment + url: https://api.github.com/orgs/github/properties/schema/environment + source_type: organization + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + values_editable_by: org_actors + - property_name: service + url: https://api.github.com/orgs/github/properties/schema/service + source_type: organization + value_type: string + - property_name: team + url: https://api.github.com/orgs/github/properties/schema/team + source_type: organization + value_type: string + description: Team owning the repository + '403': *29 + '404': *7 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties + patch: + summary: Create or update custom properties for an enterprise + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Creates new or updates existing custom properties defined for an enterprise in a batch. + + To use this endpoint, the authenticated user must be an administrator for the enterprise. + tags: + - enterprise-admin + operationId: enterprise-admin/create-or-update-enterprise-custom-properties + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-custom-properties-for-an-enterprise + parameters: + - *40 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: The array of custom properties to create or update. + items: *96 + minItems: 1 + maxItems: 100 + required: + - properties + examples: + default: + value: + properties: + - property_name: environment + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + values_editable_by: org_actors + - property_name: service + value_type: string + - property_name: team + value_type: string + description: Team owning the repository + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *96 + examples: + default: *97 + '403': *29 + '404': *7 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties + "/enterprises/{enterprise}/properties/schema/{custom_property_name}": + get: + summary: Get a custom property for an enterprise + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets a custom property that is defined for an enterprise. + Enterprise members can read these properties. + tags: + - enterprise-admin + operationId: enterprise-admin/get-enterprise-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise + parameters: + - *40 + - &98 + name: custom_property_name + description: The custom property name + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: *96 + examples: + default: &99 + value: + property_name: environment + url: https://api.github.com/orgs/github/properties/schema/environment + source_type: organization + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + '403': *29 + '404': *7 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties + put: + summary: Create or update a custom property for an enterprise + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Creates a new or updates an existing custom property that is defined for an enterprise. + + To use this endpoint, the authenticated user must be an administrator for the enterprise. + tags: + - enterprise-admin + operationId: enterprise-admin/create-or-update-enterprise-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise + parameters: + - *40 + - *98 + responses: + '200': + description: Response + content: + application/json: + schema: *96 + examples: + default: *99 + '403': *29 + '404': *7 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties + delete: + summary: Remove a custom property for an enterprise + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Remove a custom property that is defined for an enterprise. + + To use this endpoint, the authenticated user must be an administrator for the enterprise. + tags: + - enterprise-admin + operationId: enterprise-admin/remove-enterprise-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise + parameters: + - *40 + - *98 + responses: + '204': &192 + description: A header with no content is returned. + '403': *29 + '404': *7 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties "/enterprises/{enterprise}/secret-scanning/alerts": get: summary: List secret scanning alerts for an enterprise @@ -13563,7 +13860,7 @@ paths: headers: Link: *39 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -13842,7 +14139,7 @@ paths: '400': *15 '403': *29 '500': *84 - '503': *96 + '503': *100 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -13863,7 +14160,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#add-users-to-a-cost-center parameters: - *40 - - &97 + - &101 name: cost_center_id description: The ID corresponding to the cost center. in: path @@ -13905,13 +14202,13 @@ paths: message: Resources successfully added to the cost center. '400': *15 '403': *29 - '409': &146 + '409': &150 description: Conflict content: application/json: schema: *3 '500': *84 - '503': *96 + '503': *100 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -13931,7 +14228,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#remove-users-from-a-cost-center parameters: - *40 - - *97 + - *101 requestBody: required: true content: @@ -13969,7 +14266,7 @@ paths: '400': *15 '403': *29 '500': *84 - '503': *96 + '503': *100 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -14090,7 +14387,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise parameters: - *40 - - &135 + - &139 name: year description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, @@ -14099,7 +14396,7 @@ paths: required: false schema: type: integer - - &136 + - &140 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. @@ -14107,7 +14404,7 @@ paths: required: false schema: type: integer - - &137 + - &141 name: day description: If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. @@ -14115,7 +14412,7 @@ paths: required: false schema: type: integer - - &138 + - &142 name: hour description: If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. @@ -14135,7 +14432,7 @@ paths: description: Response when getting a billing usage report content: application/json: - schema: &139 + schema: &143 type: object properties: usageItems: @@ -14188,7 +14485,7 @@ paths: - netAmount - organizationName examples: - default: &140 + default: &144 value: usageItems: - date: '2023-08-01' @@ -14205,7 +14502,7 @@ paths: '400': *15 '403': *29 '500': *84 - '503': *96 + '503': *100 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -14215,6 +14512,9 @@ paths: get: summary: Get Copilot metrics for an enterprise team description: |- + > [!NOTE] + > This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, @@ -14273,13 +14573,13 @@ paths: application/json: schema: type: array - items: *98 + items: *102 examples: - default: *99 + default: *103 '500': *84 '403': *29 '404': *7 - '422': *100 + '422': *104 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14290,7 +14590,7 @@ paths: summary: Get a summary of Copilot usage for an enterprise team description: |- > [!NOTE] - > This endpoint is in public preview and is subject to change. + > This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -14314,7 +14614,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team parameters: - *40 - - &250 + - &254 name: team_slug description: The slug of the team name. in: path @@ -14352,9 +14652,9 @@ paths: application/json: schema: type: array - items: *101 + items: *105 examples: - default: &194 + default: &198 value: - day: '2023-10-15' total_suggestions_count: 1000 @@ -14510,7 +14810,7 @@ paths: application/json: schema: type: array - items: &130 + items: &134 title: Event description: Event type: object @@ -14520,7 +14820,7 @@ paths: type: type: string nullable: true - actor: &102 + actor: &106 title: Actor description: Actor type: object @@ -14560,13 +14860,13 @@ paths: - id - name - url - org: *102 + org: *106 payload: type: object properties: action: type: string - issue: &118 + issue: &122 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -14841,9 +15141,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 - author_association: &105 + properties: *107 + required: *108 + author_association: &109 title: author_association type: string example: OWNER @@ -14857,7 +15157,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &106 + reactions: &110 title: Reaction Rollup type: object properties: @@ -14977,7 +15277,7 @@ paths: issue_url: type: string format: uri - author_association: *105 + author_association: *109 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -14987,9 +15287,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 - reactions: *106 + properties: *107 + required: *108 + reactions: *110 required: - id - node_id @@ -15084,7 +15384,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15165,7 +15465,7 @@ paths: _links: type: object properties: - timeline: &107 + timeline: &111 title: Link With Type description: Hypermedia Link with Type type: object @@ -15177,17 +15477,17 @@ paths: required: - href - type - user: *107 - security_advisories: *107 - current_user: *107 - current_user_public: *107 - current_user_actor: *107 - current_user_organization: *107 + user: *111 + security_advisories: *111 + current_user: *111 + current_user_public: *111 + current_user_actor: *111 + current_user_organization: *111 current_user_organizations: type: array - items: *107 - repository_discussions: *107 - repository_discussions_category: *107 + items: *111 + repository_discussions: *111 + repository_discussions_category: *111 required: - timeline - user @@ -15249,7 +15549,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *108 + - *112 - *18 - *20 responses: @@ -15259,7 +15559,7 @@ paths: application/json: schema: type: array - items: &109 + items: &113 title: Base Gist description: Base Gist type: object @@ -15356,7 +15656,7 @@ paths: - created_at - updated_at examples: - default: &110 + default: &114 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -15477,7 +15777,7 @@ paths: description: Response content: application/json: - schema: &111 + schema: &115 title: Gist Simple description: Gist Simple type: object @@ -15852,7 +16152,7 @@ paths: truncated: type: boolean examples: - default: &112 + default: &116 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -15955,7 +16255,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *108 + - *112 - *18 - *20 responses: @@ -15965,9 +16265,9 @@ paths: application/json: schema: type: array - items: *109 + items: *113 examples: - default: *110 + default: *114 headers: Link: *39 '422': *16 @@ -15989,7 +16289,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *108 + - *112 - *18 - *20 responses: @@ -15999,9 +16299,9 @@ paths: application/json: schema: type: array - items: *109 + items: *113 examples: - default: *110 + default: *114 headers: Link: *39 '401': *25 @@ -16029,7 +16329,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &113 + - &117 name: gist_id description: The unique identifier of the gist. in: path @@ -16041,10 +16341,10 @@ paths: description: Response content: application/json: - schema: *111 + schema: *115 examples: - default: *112 - '403': &116 + default: *116 + '403': &120 description: Forbidden Gist content: application/json: @@ -16092,7 +16392,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *113 + - *117 requestBody: required: true content: @@ -16152,9 +16452,9 @@ paths: description: Response content: application/json: - schema: *111 + schema: *115 examples: - updateGist: *112 + updateGist: *116 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -16312,7 +16612,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *113 + - *117 responses: '204': description: Response @@ -16341,7 +16641,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *113 + - *117 - *18 - *20 responses: @@ -16351,7 +16651,7 @@ paths: application/json: schema: type: array - items: &114 + items: &118 title: Gist Comment description: A comment made to a gist. type: object @@ -16386,7 +16686,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *105 + author_association: *109 required: - url - id @@ -16451,7 +16751,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *113 + - *117 requestBody: required: true content: @@ -16476,9 +16776,9 @@ paths: description: Response content: application/json: - schema: *114 + schema: *118 examples: - default: &115 + default: &119 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -16536,8 +16836,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *113 - - &117 + - *117 + - &121 name: comment_id description: The unique identifier of the comment. in: path @@ -16550,12 +16850,12 @@ paths: description: Response content: application/json: - schema: *114 + schema: *118 examples: - default: *115 + default: *119 '304': *37 '404': *7 - '403': *116 + '403': *120 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -16577,8 +16877,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *113 - *117 + - *121 requestBody: required: true content: @@ -16603,9 +16903,9 @@ paths: description: Response content: application/json: - schema: *114 + schema: *118 examples: - default: *115 + default: *119 '404': *7 x-github: githubCloudOnly: false @@ -16622,8 +16922,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *113 - *117 + - *121 responses: '204': description: Response @@ -16646,7 +16946,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *113 + - *117 - *18 - *20 responses: @@ -16747,7 +17047,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *113 + - *117 - *18 - *20 responses: @@ -16757,7 +17057,7 @@ paths: application/json: schema: type: array - items: *111 + items: *115 examples: default: value: @@ -16822,13 +17122,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *113 + - *117 responses: '201': description: Response content: application/json: - schema: *109 + schema: *113 examples: default: value: @@ -16899,7 +17199,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *113 + - *117 responses: '204': description: Response if gist is starred @@ -16929,7 +17229,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *113 + - *117 responses: '204': description: Response @@ -16951,7 +17251,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *113 + - *117 responses: '204': description: Response @@ -16980,7 +17280,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *113 + - *117 - name: sha in: path required: true @@ -16991,9 +17291,9 @@ paths: description: Response content: application/json: - schema: *111 + schema: *115 examples: - default: *112 + default: *116 '422': *16 '404': *7 '403': *29 @@ -17359,7 +17659,7 @@ paths: - closed - all default: open - - &239 + - &243 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -17378,7 +17678,7 @@ paths: - comments default: created - *78 - - *108 + - *112 - name: collab in: query required: false @@ -17408,9 +17708,9 @@ paths: application/json: schema: type: array - items: *118 + items: *122 examples: - default: &240 + default: &244 value: - id: 1 node_id: MDU6SXNzdWUx @@ -17694,8 +17994,8 @@ paths: title: License Simple description: License Simple type: object - properties: *119 - required: *120 + properties: *123 + required: *124 examples: default: value: @@ -17979,7 +18279,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &121 + X-CommonMarker-Version: &125 example: 0.17.4 schema: type: string @@ -18034,7 +18334,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *121 + X-CommonMarker-Version: *125 content: text/html: schema: @@ -18063,7 +18363,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &124 + - &128 name: account_id description: account_id parameter in: path @@ -18075,7 +18375,7 @@ paths: description: Response content: application/json: - schema: &123 + schema: &127 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -18105,7 +18405,7 @@ paths: nullable: true id: type: integer - plan: &122 + plan: &126 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -18194,7 +18494,7 @@ paths: nullable: true updated_at: type: string - plan: *122 + plan: *126 required: - url - id @@ -18202,7 +18502,7 @@ paths: - login - marketplace_purchase examples: - default: &125 + default: &129 value: url: https://api.github.com/orgs/github type: Organization @@ -18287,9 +18587,9 @@ paths: application/json: schema: type: array - items: *122 + items: *126 examples: - default: &126 + default: &130 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -18329,14 +18629,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &127 + - &131 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &128 + - &132 name: sort description: The property to sort the results by. in: query @@ -18366,9 +18666,9 @@ paths: application/json: schema: type: array - items: *123 + items: *127 examples: - default: &129 + default: &133 value: - url: https://api.github.com/orgs/github type: Organization @@ -18442,15 +18742,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *124 + - *128 responses: '200': description: Response content: application/json: - schema: *123 + schema: *127 examples: - default: *125 + default: *129 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -18482,9 +18782,9 @@ paths: application/json: schema: type: array - items: *122 + items: *126 examples: - default: *126 + default: *130 headers: Link: *39 '401': *25 @@ -18507,8 +18807,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *127 - - *128 + - *131 + - *132 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -18528,9 +18828,9 @@ paths: application/json: schema: type: array - items: *123 + items: *127 examples: - default: *129 + default: *133 headers: Link: *39 '401': *25 @@ -18803,7 +19103,7 @@ paths: application/json: schema: type: array - items: *130 + items: *134 examples: default: value: @@ -18896,7 +19196,7 @@ paths: schema: type: boolean default: false - - *108 + - *112 - &540 name: before description: 'Only show notifications updated before the given time. This @@ -18922,18 +19222,18 @@ paths: application/json: schema: type: array - items: &131 + items: &135 title: Thread description: Thread type: object properties: id: type: string - repository: &159 + repository: &163 title: Minimal Repository description: Minimal Repository type: object - properties: &211 + properties: &215 id: type: integer format: int64 @@ -19273,7 +19573,7 @@ paths: enum: - enabled - disabled - required: &212 + required: &216 - archive_url - assignees_url - blobs_url @@ -19527,7 +19827,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &132 + - &136 name: thread_id description: The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications @@ -19541,7 +19841,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *135 examples: default: value: @@ -19644,7 +19944,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *132 + - *136 responses: '205': description: Reset Content @@ -19667,7 +19967,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *132 + - *136 responses: '204': description: No content @@ -19690,13 +19990,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *132 + - *136 responses: '200': description: Response content: application/json: - schema: &133 + schema: &137 title: Thread Subscription description: Thread Subscription type: object @@ -19733,7 +20033,7 @@ paths: - url - subscribed examples: - default: &134 + default: &138 value: subscribed: true ignored: false @@ -19764,7 +20064,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *132 + - *136 requestBody: required: false content: @@ -19785,9 +20085,9 @@ paths: description: Response content: application/json: - schema: *133 + schema: *137 examples: - default: *134 + default: *138 '304': *37 '403': *29 '401': *25 @@ -19810,7 +20110,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *132 + - *136 responses: '204': description: Response @@ -19971,7 +20271,7 @@ paths: type: integer custom_roles: type: array - items: &195 + items: &199 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -20019,7 +20319,7 @@ paths: - created_at - updated_at examples: - default: &196 + default: &200 value: id: 8030 name: Security Engineer @@ -20065,29 +20365,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - - &141 + - &145 name: org description: The organization name. The name is not case sensitive. in: path required: true schema: type: string - - *135 - - *136 - - *137 - - *138 + - *139 + - *140 + - *141 + - *142 responses: '200': description: Billing usage report response for an organization content: application/json: - schema: *139 + schema: *143 examples: - default: *140 + default: *144 '400': *15 '403': *29 '500': *84 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20113,13 +20413,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization parameters: - - *141 + - *145 responses: '200': description: Response content: application/json: - schema: &142 + schema: &146 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -20422,7 +20722,7 @@ paths: - updated_at - archived_at examples: - default-response: &143 + default-response: &147 value: login: github id: 1 @@ -20515,7 +20815,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization parameters: - - *141 + - *145 requestBody: required: false content: @@ -20738,18 +21038,18 @@ paths: description: Response content: application/json: - schema: *142 + schema: *146 examples: - default: *143 + default: *147 '422': description: Validation failed content: application/json: schema: oneOf: - - *144 - - *145 - '409': *146 + - *148 + - *149 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20772,9 +21072,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization parameters: - - *141 + - *145 responses: - '202': *147 + '202': *151 '404': *7 '403': *29 x-github: @@ -20797,15 +21097,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response content: application/json: - schema: *148 + schema: *152 examples: - default: *149 + default: *153 headers: Link: *39 x-github: @@ -20828,7 +21128,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - - *141 + - *145 - *18 - *20 responses: @@ -20901,13 +21201,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *141 + - *145 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &150 + schema: &154 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -20921,7 +21221,7 @@ paths: required: - include_claim_keys examples: - default: &151 + default: &155 value: include_claim_keys: - repo @@ -20943,20 +21243,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *141 + - *145 requestBody: required: true content: application/json: - schema: *150 + schema: *154 examples: - default: *151 + default: *155 responses: '201': description: Empty response content: application/json: - schema: &170 + schema: &174 title: Empty Object description: An object without any properties. type: object @@ -20986,7 +21286,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -20995,7 +21295,7 @@ paths: schema: type: object properties: - enabled_repositories: &153 + enabled_repositories: &157 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -21009,7 +21309,7 @@ paths: that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: *42 - selected_actions_url: *152 + selected_actions_url: *156 required: - enabled_repositories examples: @@ -21038,7 +21338,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *141 + - *145 responses: '204': description: Response @@ -21049,7 +21349,7 @@ paths: schema: type: object properties: - enabled_repositories: *153 + enabled_repositories: *157 allowed_actions: *42 required: - enabled_repositories @@ -21077,7 +21377,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *141 + - *145 - *18 - *20 responses: @@ -21237,7 +21537,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *141 + - *145 responses: '204': description: Response @@ -21281,8 +21581,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *141 - - &154 + - *145 + - &158 name: repository_id description: The unique identifier of the repository. in: path @@ -21310,8 +21610,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *141 - - *154 + - *145 + - *158 responses: '204': description: Response @@ -21334,7 +21634,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -21365,7 +21665,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *141 + - *145 responses: '204': description: Response @@ -21397,13 +21697,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response content: application/json: - schema: *155 + schema: *159 examples: default: *48 x-github: @@ -21426,7 +21726,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *141 + - *145 responses: '204': description: Success response @@ -21437,7 +21737,7 @@ paths: required: false content: application/json: - schema: *156 + schema: *160 examples: default: *48 x-github: @@ -21459,7 +21759,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - - *141 + - *145 - *18 - *20 - name: visible_to_repository @@ -21484,7 +21784,7 @@ paths: type: number runner_groups: type: array - items: &157 + items: &161 type: object properties: id: @@ -21596,7 +21896,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - - *141 + - *145 requestBody: required: true content: @@ -21665,9 +21965,9 @@ paths: description: Response content: application/json: - schema: *157 + schema: *161 examples: - default: &158 + default: &162 value: id: 2 name: octo-runner-group @@ -21702,14 +22002,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - - *141 + - *145 - *51 responses: '200': description: Response content: application/json: - schema: *157 + schema: *161 examples: default: value: @@ -21745,7 +22045,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - - *141 + - *145 - *51 requestBody: required: true @@ -21796,9 +22096,9 @@ paths: description: Response content: application/json: - schema: *157 + schema: *161 examples: - default: *158 + default: *162 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21817,7 +22117,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - - *141 + - *145 - *51 responses: '204': @@ -21841,7 +22141,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *141 + - *145 - *51 - *20 - *18 @@ -21860,7 +22160,7 @@ paths: type: number repositories: type: array - items: *159 + items: *163 examples: default: &660 value: @@ -22114,7 +22414,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - - *141 + - *145 - *51 requestBody: required: true @@ -22159,9 +22459,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *141 + - *145 - *51 - - *154 + - *158 responses: '204': description: Response @@ -22183,9 +22483,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *141 + - *145 - *51 - - *154 + - *158 responses: '204': description: Response @@ -22208,7 +22508,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - - *141 + - *145 - *51 - *18 - *20 @@ -22250,7 +22550,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - - *141 + - *145 - *51 requestBody: required: true @@ -22295,7 +22595,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - - *141 + - *145 - *51 - *54 responses: @@ -22319,7 +22619,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - - *141 + - *145 - *51 - *54 responses: @@ -22351,7 +22651,7 @@ paths: in: query schema: type: string - - *141 + - *145 - *18 - *20 responses: @@ -22395,7 +22695,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -22403,9 +22703,9 @@ paths: application/json: schema: type: array - items: *160 + items: *164 examples: - default: *161 + default: *165 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22427,7 +22727,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - - *141 + - *145 requestBody: required: true content: @@ -22470,7 +22770,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *162 + '201': *166 '404': *7 '422': *8 x-github: @@ -22500,7 +22800,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *141 + - *145 responses: '201': description: Response @@ -22508,7 +22808,7 @@ paths: application/json: schema: *58 examples: - default: *163 + default: *167 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22536,7 +22836,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *141 + - *145 responses: '201': description: Response @@ -22544,7 +22844,7 @@ paths: application/json: schema: *58 examples: - default: *164 + default: *168 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22566,7 +22866,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - - *141 + - *145 - *54 responses: '200': @@ -22575,7 +22875,7 @@ paths: application/json: schema: *55 examples: - default: *165 + default: *169 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22596,7 +22896,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - - *141 + - *145 - *54 responses: '204': @@ -22622,7 +22922,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *141 + - *145 - *54 responses: '200': *60 @@ -22647,7 +22947,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - - *141 + - *145 - *54 requestBody: required: true @@ -22696,7 +22996,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *141 + - *145 - *54 requestBody: required: true @@ -22746,10 +23046,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - - *141 + - *145 - *54 responses: - '200': *166 + '200': *170 '404': *7 x-github: githubCloudOnly: false @@ -22776,9 +23076,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - - *141 + - *145 - *54 - - *167 + - *171 responses: '200': *60 '404': *7 @@ -22805,7 +23105,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets parameters: - - *141 + - *145 - *18 - *20 responses: @@ -22823,7 +23123,7 @@ paths: type: integer secrets: type: array - items: &168 + items: &172 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -22896,7 +23196,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key parameters: - - *141 + - *145 responses: '200': description: Response @@ -22956,8 +23256,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - - *141 - - &169 + - *145 + - &173 name: secret_name description: The name of the secret. in: path @@ -22969,7 +23269,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *172 examples: default: value: @@ -22999,8 +23299,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 requestBody: required: true content: @@ -23055,7 +23355,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -23081,8 +23381,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 responses: '204': description: Response @@ -23108,8 +23408,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 - *20 - *18 responses: @@ -23127,9 +23427,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *163 examples: - default: &173 + default: &177 value: total_count: 1 repositories: @@ -23221,8 +23521,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 requestBody: required: true content: @@ -23274,8 +23574,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 - name: repository_id in: path required: true @@ -23308,8 +23608,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 - name: repository_id in: path required: true @@ -23341,7 +23641,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - - *141 + - *145 - &348 name: per_page description: The number of results per page (max 30). For more information, @@ -23366,7 +23666,7 @@ paths: type: integer variables: type: array - items: &171 + items: &175 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -23451,7 +23751,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable parameters: - - *141 + - *145 requestBody: required: true content: @@ -23499,7 +23799,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -23524,8 +23824,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - - *141 - - &172 + - *145 + - &176 name: name description: The name of the variable. in: path @@ -23537,7 +23837,7 @@ paths: description: Response content: application/json: - schema: *171 + schema: *175 examples: default: value: @@ -23567,8 +23867,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - - *141 - - *172 + - *145 + - *176 requestBody: required: true content: @@ -23630,8 +23930,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - - *141 - - *172 + - *145 + - *176 responses: '204': description: Response @@ -23657,8 +23957,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *141 - - *172 + - *145 + - *176 - *20 - *18 responses: @@ -23676,9 +23976,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *163 examples: - default: *173 + default: *177 '409': description: Response when the visibility of the variable is not set to `selected` @@ -23704,8 +24004,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *141 - - *172 + - *145 + - *176 requestBody: required: true content: @@ -23754,8 +24054,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *141 - - *172 + - *145 + - *176 - name: repository_id in: path required: true @@ -23789,8 +24089,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *141 - - *172 + - *145 + - *176 - name: repository_id in: path required: true @@ -23821,7 +24121,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -23848,11 +24148,11 @@ paths: required: true content: application/json: - schema: *174 + schema: *178 examples: default: *63 parameters: - - *141 + - *145 responses: '200': description: Response @@ -23876,7 +24176,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - - *141 + - *145 responses: '204': description: Response @@ -23904,7 +24204,7 @@ paths: - *18 - *76 - *77 - - *141 + - *145 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -24063,7 +24363,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-the-audit-log-for-an-organization parameters: - - *141 + - *145 - name: phrase description: A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). @@ -24071,10 +24371,10 @@ paths: required: false schema: type: string - - *175 - - *176 - - *177 - - *178 + - *179 + - *180 + - *181 + - *182 - *18 responses: '200': @@ -24083,9 +24383,9 @@ paths: application/json: schema: type: array - items: *179 + items: *183 examples: - default: *180 + default: *184 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -24102,7 +24402,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *141 + - *145 - *18 - *20 responses: @@ -24114,7 +24414,7 @@ paths: type: array items: *19 examples: - default: &241 + default: &245 value: - login: octocat id: 1 @@ -24152,8 +24452,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *141 - - &181 + - *145 + - &185 name: username description: The handle for the GitHub user account. in: path @@ -24184,8 +24484,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response @@ -24205,8 +24505,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response @@ -24231,9 +24531,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *141 - - *182 - - *183 + - *145 + - *186 + - *187 - *76 - *77 - *20 @@ -24244,7 +24544,7 @@ paths: be returned. in: query required: false - schema: *184 + schema: *188 - name: sort description: The property by which to sort the results. in: query @@ -24278,13 +24578,13 @@ paths: application/json: schema: type: array - items: *185 + items: *189 examples: - default: *186 + default: *190 headers: Link: *39 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24306,7 +24606,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *141 + - *145 - name: target_type in: query description: The target type of the code security configuration @@ -24334,7 +24634,7 @@ paths: application/json: schema: type: array - items: &187 + items: &191 type: object description: A code security configuration properties: @@ -24573,7 +24873,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration parameters: - - *141 + - *145 requestBody: required: true content: @@ -24745,9 +25045,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *187 + schema: *191 examples: - default: &188 + default: &193 value: id: 1325 target_type: organization @@ -24793,7 +25093,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations parameters: - - *141 + - *145 responses: '200': description: Response @@ -24813,7 +25113,7 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *187 + configuration: *191 examples: default: value: @@ -24897,7 +25197,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *141 + - *145 requestBody: required: true content: @@ -24920,12 +25220,11 @@ paths: - 32 - 91 responses: - '204': &190 - description: A header with no content is returned. + '204': *192 '400': *15 '403': *29 '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24947,8 +25246,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration parameters: - - *141 - - &189 + - *145 + - &194 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -24960,9 +25259,9 @@ paths: description: Response content: application/json: - schema: *187 + schema: *191 examples: - default: *188 + default: *193 '304': *37 '403': *29 '404': *7 @@ -24986,8 +25285,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration parameters: - - *141 - - *189 + - *145 + - *194 requestBody: required: true content: @@ -25139,7 +25438,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *187 + schema: *191 examples: default: value: @@ -25190,14 +25489,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *141 - - *189 + - *145 + - *194 responses: - '204': *190 + '204': *192 '400': *15 '403': *29 '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25221,8 +25520,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *141 - - *189 + - *145 + - *194 requestBody: required: true content: @@ -25261,7 +25560,7 @@ paths: - 32 - 91 responses: - '202': *147 + '202': *151 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25285,8 +25584,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - - *141 - - *189 + - *145 + - *194 requestBody: required: true content: @@ -25326,12 +25625,12 @@ paths: - none - private_and_internal - public - configuration: *187 + configuration: *191 examples: default: value: default_for_new_repos: all - configuration: *188 + configuration: *193 '403': *29 '404': *7 x-github: @@ -25355,8 +25654,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *141 - - *189 + - *145 + - *194 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -25499,7 +25798,7 @@ paths: parameters: - *18 - *20 - - *141 + - *145 responses: '200': description: Response @@ -25515,7 +25814,7 @@ paths: type: integer codespaces: type: array - items: &242 + items: &246 type: object title: Codespace description: A codespace. @@ -25540,7 +25839,7 @@ paths: nullable: true owner: *19 billable_owner: *19 - repository: *159 + repository: *163 machine: type: object title: Codespace machine @@ -25792,7 +26091,7 @@ paths: - pulls_url - recent_folders examples: - default: &243 + default: &247 value: total_count: 3 codespaces: @@ -26224,7 +26523,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *141 + - *145 deprecated: true requestBody: required: true @@ -26291,7 +26590,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *141 + - *145 deprecated: true requestBody: required: true @@ -26346,7 +26645,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *141 + - *145 requestBody: required: true content: @@ -26398,7 +26697,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *141 + - *145 - *18 - *20 responses: @@ -26416,7 +26715,7 @@ paths: type: integer secrets: type: array - items: &191 + items: &195 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -26487,7 +26786,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *141 + - *145 responses: '200': description: Response @@ -26545,14 +26844,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 responses: '200': description: Response content: application/json: - schema: *191 + schema: *195 examples: default: &436 value: @@ -26581,8 +26880,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 requestBody: required: true content: @@ -26637,7 +26936,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -26663,8 +26962,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 responses: '204': description: Response @@ -26689,8 +26988,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 - *20 - *18 responses: @@ -26708,9 +27007,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *163 examples: - default: *173 + default: *177 '404': *7 x-github: githubCloudOnly: false @@ -26732,8 +27031,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 requestBody: required: true content: @@ -26783,8 +27082,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 - name: repository_id in: path required: true @@ -26817,8 +27116,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 - name: repository_id in: path required: true @@ -26857,7 +27156,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - - *141 + - *145 responses: '200': description: OK @@ -27000,7 +27299,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - - *141 + - *145 - *20 - name: per_page description: The number of results per page (max 100). For more information, @@ -27023,9 +27322,9 @@ paths: currently being billed. seats: type: array - items: *192 + items: *196 examples: - default: *193 + default: *197 headers: Link: *39 '500': *84 @@ -27047,13 +27346,11 @@ paths: Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-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. + Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." - The response will contain the total number of new seats that were created and existing seats that were refreshed. + The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -27063,7 +27360,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - - *141 + - *145 requestBody: content: application/json: @@ -27127,14 +27424,11 @@ paths: Sets seats for all members of each team specified to "pending cancellation". This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - - For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. - The response will contain the total number of seats set to "pending cancellation". + The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -27144,7 +27438,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - - *141 + - *145 requestBody: content: application/json: @@ -27210,13 +27504,11 @@ paths: Purchases a GitHub Copilot seat for each user specified. The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-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. + Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." - The response will contain the total number of new seats that were created and existing seats that were refreshed. + The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -27226,7 +27518,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - - *141 + - *145 requestBody: content: application/json: @@ -27289,14 +27581,11 @@ paths: Sets seats for all users specified to "pending cancellation". This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - - For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. - The response will contain the total number of seats set to "pending cancellation". + The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -27306,7 +27595,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - - *141 + - *145 requestBody: content: application/json: @@ -27387,7 +27676,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *141 + - *145 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -27419,13 +27708,13 @@ paths: application/json: schema: type: array - items: *98 + items: *102 examples: - default: *99 + default: *103 '500': *84 '403': *29 '404': *7 - '422': *100 + '422': *104 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27456,7 +27745,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-organization-members parameters: - - *141 + - *145 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -27488,9 +27777,9 @@ paths: application/json: schema: type: array - items: *101 + items: *105 examples: - default: *194 + default: *198 '500': *84 '401': *25 '403': *29 @@ -27516,7 +27805,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization parameters: - - *141 + - *145 - *18 - name: page description: Page token @@ -27660,7 +27949,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization parameters: - - *141 + - *145 - name: credential_id in: path required: true @@ -27691,7 +27980,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization parameters: - - *141 + - *145 responses: '200': description: Response - list of custom role names @@ -27706,7 +27995,7 @@ paths: type: integer custom_roles: type: array - items: *195 + items: *199 examples: default: value: @@ -27793,12 +28082,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role parameters: - - *141 + - *145 requestBody: required: true content: application/json: - schema: &198 + schema: &202 type: object properties: name: @@ -27839,9 +28128,9 @@ paths: description: Response content: application/json: - schema: *195 + schema: *199 examples: - default: *196 + default: *200 '422': *16 '404': *7 x-github: @@ -27865,8 +28154,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role parameters: - - *141 - - &197 + - *145 + - &201 name: role_id description: The unique identifier of the role. in: path @@ -27878,9 +28167,9 @@ paths: description: Response content: application/json: - schema: *195 + schema: *199 examples: - default: *196 + default: *200 '404': *7 x-github: githubCloudOnly: true @@ -27902,13 +28191,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role parameters: - - *141 - - *197 + - *145 + - *201 requestBody: required: true content: application/json: - schema: &199 + schema: &203 type: object properties: name: @@ -27946,9 +28235,9 @@ paths: description: Response content: application/json: - schema: *195 + schema: *199 examples: - default: *196 + default: *200 '422': *16 '404': *7 x-github: @@ -27972,8 +28261,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - - *141 - - *197 + - *145 + - *201 responses: '204': description: Response @@ -28001,12 +28290,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---create-a-custom-role parameters: - - *141 + - *145 requestBody: required: true content: application/json: - schema: *198 + schema: *202 examples: default: value: @@ -28020,9 +28309,9 @@ paths: description: Response content: application/json: - schema: *195 + schema: *199 examples: - default: *196 + default: *200 '422': *16 '404': *7 x-github: @@ -28052,16 +28341,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---get-a-custom-role parameters: - - *141 - - *197 + - *145 + - *201 responses: '200': description: Response content: application/json: - schema: *195 + schema: *199 examples: - default: *196 + default: *200 '404': *7 x-github: githubCloudOnly: true @@ -28089,13 +28378,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---update-a-custom-role parameters: - - *141 - - *197 + - *145 + - *201 requestBody: required: true content: application/json: - schema: *199 + schema: *203 examples: default: value: @@ -28110,9 +28399,9 @@ paths: description: Response content: application/json: - schema: *195 + schema: *199 examples: - default: *196 + default: *200 '422': *16 '404': *7 x-github: @@ -28142,8 +28431,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---delete-a-custom-role parameters: - - *141 - - *197 + - *145 + - *201 responses: '204': description: Response @@ -28171,18 +28460,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *141 - - *200 - - *201 - - *202 - - *203 + - *145 - *204 - *205 + - *206 + - *207 + - *208 + - *209 - *78 - *76 - *77 - - *206 - - *207 + - *210 + - *211 - *18 responses: '200': @@ -28191,9 +28480,9 @@ paths: application/json: schema: type: array - items: *208 + items: *212 examples: - default: *209 + default: *213 '304': *37 '400': *15 '403': *29 @@ -28219,7 +28508,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets parameters: - - *141 + - *145 - *18 - *20 responses: @@ -28237,7 +28526,7 @@ paths: type: integer secrets: type: array - items: &210 + items: &214 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -28308,7 +28597,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key parameters: - - *141 + - *145 responses: '200': description: Response @@ -28354,14 +28643,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 responses: '200': description: Response content: application/json: - schema: *210 + schema: *214 examples: default: value: @@ -28389,8 +28678,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 requestBody: required: true content: @@ -28445,7 +28734,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -28469,8 +28758,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 responses: '204': description: Response @@ -28494,8 +28783,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 - *20 - *18 responses: @@ -28513,9 +28802,9 @@ paths: type: integer repositories: type: array - items: *159 + items: *163 examples: - default: *173 + default: *177 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28536,8 +28825,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 requestBody: required: true content: @@ -28587,8 +28876,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 - name: repository_id in: path required: true @@ -28619,8 +28908,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *141 - - *169 + - *145 + - *173 - name: repository_id in: path required: true @@ -28650,7 +28939,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -28658,7 +28947,7 @@ paths: application/json: schema: type: array - items: &254 + items: &258 title: Package description: A software package type: object @@ -28708,8 +28997,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *211 - required: *212 + properties: *215 + required: *216 nullable: true created_at: type: string @@ -28728,7 +29017,7 @@ paths: - created_at - updated_at examples: - default: &255 + default: &259 value: - id: 197 name: hello_docker @@ -28806,7 +29095,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events parameters: - - *141 + - *145 - *18 - *20 responses: @@ -28816,7 +29105,7 @@ paths: application/json: schema: type: array - items: *130 + items: *134 examples: 200-response: value: @@ -28886,7 +29175,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group parameters: - - *141 + - *145 - name: group_id description: The unique identifier of the group. in: path @@ -29031,7 +29320,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-external-groups-in-an-organization parameters: - - *141 + - *145 - *18 - name: page description: Page token @@ -29119,7 +29408,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations parameters: - - *141 + - *145 - *18 - *20 responses: @@ -29129,7 +29418,7 @@ paths: application/json: schema: type: array - items: &235 + items: &239 title: Organization Invitation description: Organization Invitation type: object @@ -29176,7 +29465,7 @@ paths: - invitation_teams_url - node_id examples: - default: &236 + default: &240 value: - id: 1 login: monalisa @@ -29235,7 +29524,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -29288,7 +29577,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks parameters: - - *141 + - *145 - *18 - *20 responses: @@ -29298,7 +29587,7 @@ paths: application/json: schema: type: array - items: &213 + items: &217 title: Org Hook description: Org Hook type: object @@ -29407,7 +29696,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook parameters: - - *141 + - *145 requestBody: required: true content: @@ -29467,9 +29756,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *217 examples: - default: &214 + default: &218 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -29513,8 +29802,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - - *141 - - &215 + - *145 + - &219 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. @@ -29527,9 +29816,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *217 examples: - default: *214 + default: *218 '404': *7 x-github: githubCloudOnly: false @@ -29550,8 +29839,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - - *141 - - *215 + - *145 + - *219 requestBody: required: false content: @@ -29596,7 +29885,7 @@ paths: description: Response content: application/json: - schema: *213 + schema: *217 examples: default: value: @@ -29635,8 +29924,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *141 - - *215 + - *145 + - *219 responses: '204': description: Response @@ -29661,8 +29950,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *141 - - *215 + - *145 + - *219 responses: '200': description: Response @@ -29690,8 +29979,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *141 - - *215 + - *145 + - *219 requestBody: required: false content: @@ -29739,10 +30028,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *141 - - *215 + - *145 + - *219 - *18 - - *216 + - *220 responses: '200': description: Response @@ -29750,9 +30039,9 @@ paths: application/json: schema: type: array - items: *217 + items: *221 examples: - default: *218 + default: *222 '400': *15 '422': *16 x-github: @@ -29775,17 +30064,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *141 - - *215 + - *145 + - *219 - *17 responses: '200': description: Response content: application/json: - schema: *219 + schema: *223 examples: - default: *220 + default: *224 '400': *15 '422': *16 x-github: @@ -29808,11 +30097,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *141 - - *215 + - *145 + - *219 - *17 responses: - '202': *147 + '202': *151 '400': *15 '422': *16 x-github: @@ -29835,8 +30124,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *141 - - *215 + - *145 + - *219 responses: '204': description: Response @@ -29858,8 +30147,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *141 - - &225 + - *145 + - &229 name: actor_type in: path description: The type of the actor @@ -29872,14 +30161,14 @@ paths: - fine_grained_pats - oauth_apps - github_apps_user_to_server - - &226 + - &230 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &221 + - &225 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -29887,7 +30176,7 @@ paths: required: true schema: type: string - - &222 + - &226 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -29973,13 +30262,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats parameters: - - *141 - - *221 - - *222 + - *145 + - *225 + - *226 - *20 - *18 - *78 - - &231 + - &235 name: sort description: The property to sort the results by. in: query @@ -30050,15 +30339,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats parameters: - - *141 - - *221 - - *222 + - *145 + - *225 + - *226 responses: '200': description: Response content: application/json: - schema: &223 + schema: &227 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -30074,7 +30363,7 @@ paths: type: integer format: int64 examples: - default: &224 + default: &228 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -30094,24 +30383,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *141 - - &227 + - *145 + - &231 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *221 - - *222 + - *225 + - *226 responses: '200': description: Response content: application/json: - schema: *223 + schema: *227 examples: - default: *224 + default: *228 x-github: enabledForGitHubApps: true category: orgs @@ -30129,19 +30418,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *141 - - *221 - - *222 + - *145 - *225 - *226 + - *229 + - *230 responses: '200': description: Response content: application/json: - schema: *223 + schema: *227 examples: - default: *224 + default: *228 x-github: enabledForGitHubApps: true category: orgs @@ -30158,10 +30447,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats parameters: - - *141 - - *221 - - *222 - - &228 + - *145 + - *225 + - *226 + - &232 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -30174,7 +30463,7 @@ paths: description: Response content: application/json: - schema: &229 + schema: &233 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -30190,7 +30479,7 @@ paths: type: integer format: int64 examples: - default: &230 + default: &234 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -30226,19 +30515,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user parameters: - - *141 - - *227 - - *221 - - *222 - - *228 + - *145 + - *231 + - *225 + - *226 + - *232 responses: '200': description: Response content: application/json: - schema: *229 + schema: *233 examples: - default: *230 + default: *234 x-github: enabledForGitHubApps: true category: orgs @@ -30255,20 +30544,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *141 + - *145 + - *229 + - *230 - *225 - *226 - - *221 - - *222 - - *228 + - *232 responses: '200': description: Response content: application/json: - schema: *229 + schema: *233 examples: - default: *230 + default: *234 x-github: enabledForGitHubApps: true category: orgs @@ -30285,14 +30574,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats parameters: - - *141 - - *227 - - *221 - - *222 + - *145 + - *231 + - *225 + - *226 - *20 - *18 - *78 - - *231 + - *235 responses: '200': description: Response @@ -30358,7 +30647,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *141 + - *145 responses: '200': description: Response @@ -30435,7 +30724,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *141 + - *145 - *18 - *20 responses: @@ -30524,7 +30813,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -30532,12 +30821,12 @@ paths: application/json: schema: anyOf: - - &233 + - &237 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &232 + limit: &236 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -30562,7 +30851,7 @@ paths: properties: {} additionalProperties: false examples: - default: &234 + default: &238 value: limit: collaborators_only origin: organization @@ -30586,7 +30875,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *141 + - *145 requestBody: required: true content: @@ -30597,7 +30886,7 @@ paths: duration type: object properties: - limit: *232 + limit: *236 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -30621,9 +30910,9 @@ paths: description: Response content: application/json: - schema: *233 + schema: *237 examples: - default: *234 + default: *238 '422': *16 x-github: githubCloudOnly: false @@ -30641,7 +30930,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *141 + - *145 responses: '204': description: Response @@ -30667,7 +30956,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations parameters: - - *141 + - *145 - *18 - *20 - name: role @@ -30701,9 +30990,9 @@ paths: application/json: schema: type: array - items: *235 + items: *239 examples: - default: *236 + default: *240 headers: Link: *39 '404': *7 @@ -30727,7 +31016,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation parameters: - - *141 + - *145 requestBody: required: false content: @@ -30781,7 +31070,7 @@ paths: description: Response content: application/json: - schema: *235 + schema: *239 examples: default: value: @@ -30837,8 +31126,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - - *141 - - &237 + - *145 + - &241 name: invitation_id description: The unique identifier of the invitation. in: path @@ -30871,8 +31160,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - - *141 - - *237 + - *145 + - *241 - *18 - *20 responses: @@ -30882,9 +31171,9 @@ paths: application/json: schema: type: array - items: *238 + items: *242 examples: - default: &253 + default: &257 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -30929,7 +31218,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *141 + - *145 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -30959,7 +31248,7 @@ paths: - closed - all default: open - - *239 + - *243 - name: sort description: What to sort results by. in: query @@ -30972,7 +31261,7 @@ paths: - comments default: created - *78 - - *108 + - *112 - *18 - *20 responses: @@ -30982,9 +31271,9 @@ paths: application/json: schema: type: array - items: *118 + items: *122 examples: - default: *240 + default: *244 headers: Link: *39 '404': *7 @@ -31006,7 +31295,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members parameters: - - *141 + - *145 - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -31042,7 +31331,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 '422': *16 @@ -31062,8 +31351,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response if requester is an organization member and user is @@ -31094,8 +31383,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response @@ -31121,8 +31410,8 @@ paths: parameters: - *18 - *20 - - *141 - - *181 + - *145 + - *185 responses: '200': description: Response @@ -31138,9 +31427,9 @@ paths: type: integer codespaces: type: array - items: *242 + items: *246 examples: - default: *243 + default: *247 '304': *37 '500': *84 '401': *25 @@ -31165,9 +31454,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *141 - - *181 - - &244 + - *145 + - *185 + - &248 name: codespace_name in: path required: true @@ -31175,7 +31464,7 @@ paths: schema: type: string responses: - '202': *147 + '202': *151 '304': *37 '500': *84 '401': *25 @@ -31200,15 +31489,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *141 - - *181 - - *244 + - *145 + - *185 + - *248 responses: '200': description: Response content: application/json: - schema: *242 + schema: *246 examples: default: &429 value: @@ -31383,14 +31672,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - - *141 - - *181 + - *145 + - *185 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *192 + schema: *196 examples: default: value: @@ -31458,14 +31747,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user parameters: - - *141 - - *181 + - *145 + - *185 responses: '200': description: Response content: application/json: - schema: &245 + schema: &249 title: Org Membership description: Org Membership type: object @@ -31517,7 +31806,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &246 + response-if-user-has-an-active-admin-membership-with-organization: &250 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -31585,8 +31874,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user parameters: - - *141 - - *181 + - *145 + - *185 requestBody: required: false content: @@ -31614,9 +31903,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *249 examples: - response-if-user-already-had-membership-with-organization: *246 + response-if-user-already-had-membership-with-organization: *250 '422': *16 '403': *29 x-github: @@ -31637,8 +31926,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response @@ -31663,7 +31952,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations parameters: - - *141 + - *145 - *18 - *20 - name: exclude @@ -31684,7 +31973,7 @@ paths: application/json: schema: type: array - items: &247 + items: &251 title: Migration description: A migration. type: object @@ -31937,7 +32226,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration parameters: - - *141 + - *145 requestBody: required: true content: @@ -32013,7 +32302,7 @@ paths: description: Response content: application/json: - schema: *247 + schema: *251 examples: default: value: @@ -32191,8 +32480,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - - *141 - - &248 + - *145 + - &252 name: migration_id description: The unique identifier of the migration. in: path @@ -32219,7 +32508,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *247 + schema: *251 examples: default: value: @@ -32388,8 +32677,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *141 - - *248 + - *145 + - *252 responses: '302': description: Response @@ -32410,8 +32699,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *141 - - *248 + - *145 + - *252 responses: '204': description: Response @@ -32434,8 +32723,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - - *141 - - *248 + - *145 + - *252 - &674 name: repo_name description: repo_name parameter @@ -32463,8 +32752,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *141 - - *248 + - *145 + - *252 - *18 - *20 responses: @@ -32474,9 +32763,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: &260 + default: &264 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -32615,7 +32904,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -32669,7 +32958,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response - list of organization roles @@ -32685,7 +32974,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &249 + items: &253 title: Organization Role description: Organization roles type: object @@ -32845,7 +33134,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role parameters: - - *141 + - *145 requestBody: required: true content: @@ -32892,7 +33181,7 @@ paths: description: Response content: application/json: - schema: *249 + schema: *253 examples: default: value: @@ -32921,7 +33210,7 @@ paths: updated_at: '2022-07-04T22:19:11Z' '422': *16 '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -32943,8 +33232,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *141 - - *250 + - *145 + - *254 responses: '204': description: Response @@ -32969,9 +33258,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *141 - - *250 - - *197 + - *145 + - *254 + - *201 responses: '204': description: Response @@ -33000,9 +33289,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *141 - - *250 - - *197 + - *145 + - *254 + - *201 responses: '204': description: Response @@ -33027,8 +33316,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response @@ -33053,9 +33342,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *141 - - *181 - - *197 + - *145 + - *185 + - *201 responses: '204': description: Response @@ -33085,9 +33374,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *141 - - *181 - - *197 + - *145 + - *185 + - *201 responses: '204': description: Response @@ -33115,14 +33404,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role parameters: - - *141 - - *197 + - *145 + - *201 responses: '200': description: Response content: application/json: - schema: *249 + schema: *253 examples: default: value: @@ -33179,8 +33468,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role parameters: - - *141 - - *197 + - *145 + - *201 requestBody: required: true content: @@ -33219,7 +33508,7 @@ paths: description: Response content: application/json: - schema: *249 + schema: *253 examples: default: value: @@ -33247,7 +33536,7 @@ paths: created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': *16 - '409': *146 + '409': *150 '404': *7 x-github: githubCloudOnly: true @@ -33272,8 +33561,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - - *141 - - *197 + - *145 + - *201 responses: '204': description: Response @@ -33298,8 +33587,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - - *141 - - *197 + - *145 + - *201 - *18 - *20 responses: @@ -33377,8 +33666,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *251 - required: *252 + properties: *255 + required: *256 nullable: true required: - id @@ -33393,7 +33682,7 @@ paths: - slug - parent examples: - default: *253 + default: *257 headers: Link: *39 '404': @@ -33422,8 +33711,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - - *141 - - *197 + - *145 + - *201 - *18 - *20 responses: @@ -33456,8 +33745,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *251 - required: *252 + properties: *255 + required: *256 name: nullable: true type: string @@ -33552,7 +33841,7 @@ paths: - type - url examples: - default: *241 + default: *245 headers: Link: *39 '404': @@ -33576,7 +33865,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *141 + - *145 - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -33600,7 +33889,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 x-github: @@ -33625,8 +33914,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *141 - - *181 + - *145 + - *185 requestBody: required: false content: @@ -33683,8 +33972,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response @@ -33741,7 +34030,7 @@ paths: - docker - nuget - container - - *141 + - *145 - &676 name: visibility description: |- @@ -33778,9 +34067,9 @@ paths: application/json: schema: type: array - items: *254 + items: *258 examples: - default: *255 + default: *259 '403': *29 '401': *25 '400': &678 @@ -33805,7 +34094,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &256 + - &260 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -33823,20 +34112,20 @@ paths: - docker - nuget - container - - &257 + - &261 name: package_name description: The name of the package. in: path required: true schema: type: string - - *141 + - *145 responses: '200': description: Response content: application/json: - schema: *254 + schema: *258 examples: default: value: @@ -33888,9 +34177,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *256 - - *257 - - *141 + - *260 + - *261 + - *145 responses: '204': description: Response @@ -33922,9 +34211,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *256 - - *257 - - *141 + - *260 + - *261 + - *145 - name: token description: package token schema: @@ -33956,9 +34245,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *256 - - *257 - - *141 + - *260 + - *261 + - *145 - *20 - *18 - name: state @@ -33978,7 +34267,7 @@ paths: application/json: schema: type: array - items: &258 + items: &262 title: Package Version description: A version of a software package type: object @@ -34103,10 +34392,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *256 - - *257 - - *141 - - &259 + - *260 + - *261 + - *145 + - &263 name: package_version_id description: Unique identifier of the package version. in: path @@ -34118,7 +34407,7 @@ paths: description: Response content: application/json: - schema: *258 + schema: *262 examples: default: value: @@ -34154,10 +34443,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *256 - - *257 - - *141 - - *259 + - *260 + - *261 + - *145 + - *263 responses: '204': description: Response @@ -34189,10 +34478,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *256 - - *257 - - *141 - - *259 + - *260 + - *261 + - *145 + - *263 responses: '204': description: Response @@ -34219,10 +34508,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *141 + - *145 - *18 - *20 - - &261 + - &265 name: sort description: The property by which to sort the results. in: query @@ -34233,7 +34522,7 @@ paths: - created_at default: created_at - *78 - - &262 + - &266 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -34244,7 +34533,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &263 + - &267 name: repository description: The name of the repository to use to filter the results. in: query @@ -34252,7 +34541,7 @@ paths: schema: type: string example: Hello-World - - &264 + - &268 name: permission description: The permission to use to filter the results. in: query @@ -34260,7 +34549,7 @@ paths: schema: type: string example: issues_read - - &265 + - &269 name: last_used_before description: 'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -34270,7 +34559,7 @@ paths: schema: type: string format: date-time - - &266 + - &270 name: last_used_after description: 'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -34433,7 +34722,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *141 + - *145 requestBody: required: true content: @@ -34478,7 +34767,7 @@ paths: '422': *16 '404': *7 '403': *29 - '202': *147 + '202': *151 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34499,7 +34788,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - - *141 + - *145 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -34539,7 +34828,7 @@ paths: '422': *16 '404': *7 '403': *29 - '204': *190 + '204': *192 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34560,7 +34849,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - - *141 + - *145 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -34580,9 +34869,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: *260 + default: *264 headers: Link: *39 x-github: @@ -34605,16 +34894,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - - *141 + - *145 - *18 - *20 - - *261 - - *78 - - *262 - - *263 - - *264 - *265 + - *78 - *266 + - *267 + - *268 + - *269 + - *270 responses: '500': *84 '422': *16 @@ -34763,7 +35052,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - - *141 + - *145 requestBody: required: true content: @@ -34800,7 +35089,7 @@ paths: responses: '500': *84 '404': *7 - '202': *147 + '202': *151 '403': *29 '422': *16 x-github: @@ -34823,7 +35112,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - - *141 + - *145 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -34853,7 +35142,7 @@ paths: responses: '500': *84 '404': *7 - '204': *190 + '204': *192 '403': *29 '422': *16 x-github: @@ -34875,7 +35164,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - - *141 + - *145 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -34894,9 +35183,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: *260 + default: *264 headers: Link: *39 x-github: @@ -34918,7 +35207,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-organization-projects parameters: - - *141 + - *145 - name: state description: Indicates the state of the projects to return. in: query @@ -34939,7 +35228,7 @@ paths: application/json: schema: type: array - items: &267 + items: &271 title: Project description: Projects are a way to organize columns and cards of work. @@ -35083,7 +35372,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#create-an-organization-project parameters: - - *141 + - *145 requestBody: required: true content: @@ -35109,7 +35398,7 @@ paths: description: Response content: application/json: - schema: *267 + schema: *271 examples: default: value: @@ -35171,7 +35460,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -35179,94 +35468,9 @@ paths: application/json: schema: type: array - items: &268 - title: Organization Custom Property - description: Custom property defined on an organization - type: object - properties: - property_name: - type: string - description: The name of the property - url: - type: string - format: uri - description: The URL that can be used to fetch, update, or delete - info about this property via the API. - source_type: - type: string - description: The source type of the property - enum: - - organization - - enterprise - example: organization - value_type: - type: string - example: single_select - enum: - - string - - single_select - - multi_select - - true_false - description: The type of the value for the property - required: - type: boolean - description: Whether the property is required. - default_value: - oneOf: - - type: string - - type: array - items: - type: string - nullable: true - description: Default value of the property - description: - type: string - nullable: true - description: Short description of the property - allowed_values: - type: array - items: - type: string - maxLength: 75 - maxItems: 200 - nullable: true - description: |- - An ordered list of the allowed values of the property. - The property can have up to 200 allowed values. - values_editable_by: - type: string - nullable: true - enum: - - org_actors - - org_and_repo_actors - example: org_actors - description: Who can edit the values of the property - required: - - property_name - - value_type + items: *96 examples: - default: &269 - value: - - property_name: environment - url: https://api.github.com/orgs/github/properties/schema/environment - source_type: organization - value_type: single_select - required: true - default_value: production - description: Prod or dev environment - allowed_values: - - production - - development - values_editable_by: org_actors - - property_name: service - url: https://api.github.com/orgs/github/properties/schema/service - source_type: organization - value_type: string - - property_name: team - url: https://api.github.com/orgs/github/properties/schema/team - source_type: organization - value_type: string - description: Team owning the repository + default: *97 '403': *29 '404': *7 x-github: @@ -35289,7 +35493,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *141 + - *145 requestBody: required: true content: @@ -35300,7 +35504,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *268 + items: *96 minItems: 1 maxItems: 100 required: @@ -35330,9 +35534,9 @@ paths: application/json: schema: type: array - items: *268 + items: *96 examples: - default: *269 + default: *97 '403': *29 '404': *7 x-github: @@ -35353,33 +35557,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *141 - - &270 - name: custom_property_name - description: The custom property name - in: path - required: true - schema: - type: string + - *145 + - *98 responses: '200': description: Response content: application/json: - schema: *268 + schema: *96 examples: - default: &271 - value: - property_name: environment - url: https://api.github.com/orgs/github/properties/schema/environment - source_type: organization - value_type: single_select - required: true - default_value: production - description: Prod or dev environment - allowed_values: - - production - - development + default: *99 '403': *29 '404': *7 x-github: @@ -35402,8 +35589,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *141 - - *270 + - *145 + - *98 requestBody: required: true content: @@ -35462,9 +35649,9 @@ paths: description: Response content: application/json: - schema: *268 + schema: *96 examples: - default: *271 + default: *99 '403': *29 '404': *7 x-github: @@ -35487,10 +35674,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *141 - - *270 + - *145 + - *98 responses: - '204': *190 + '204': *192 '403': *29 '404': *7 x-github: @@ -35511,7 +35698,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *141 + - *145 - *18 - *20 - name: repository_query @@ -35616,7 +35803,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - - *141 + - *145 requestBody: required: true content: @@ -35677,7 +35864,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members parameters: - - *141 + - *145 - *18 - *20 responses: @@ -35689,7 +35876,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 x-github: @@ -35708,8 +35895,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response if user is a public member @@ -35733,8 +35920,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response @@ -35755,8 +35942,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *141 - - *181 + - *145 + - *185 responses: '204': description: Response @@ -35780,7 +35967,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories parameters: - - *141 + - *145 - name: type description: Specifies the types of repositories you want returned. `internal` is not yet supported when a GitHub App calls this endpoint with an installation @@ -35827,9 +36014,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: *260 + default: *264 headers: Link: *39 x-github: @@ -35850,7 +36037,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository parameters: - - *141 + - *145 requestBody: required: true content: @@ -36397,8 +36584,8 @@ paths: title: License Simple description: License Simple type: object - properties: *119 - required: *120 + properties: *123 + required: *124 nullable: true organization: title: Simple User @@ -37048,7 +37235,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -37080,7 +37267,7 @@ paths: category: orgs subcategory: rules parameters: - - *141 + - *145 - *18 - *20 - &587 @@ -38072,7 +38259,7 @@ paths: category: orgs subcategory: rules parameters: - - *141 + - *145 requestBody: description: Request body required: true @@ -38195,7 +38382,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *141 + - *145 - &588 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally @@ -38352,7 +38539,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *141 + - *145 - &594 name: rule_suite_id description: |- @@ -38529,7 +38716,7 @@ paths: category: orgs subcategory: rules parameters: - - *141 + - *145 - name: ruleset_id description: The ID of the ruleset. in: path @@ -38561,7 +38748,7 @@ paths: category: orgs subcategory: rules parameters: - - *141 + - *145 - name: ruleset_id description: The ID of the ruleset. in: path @@ -38650,7 +38837,7 @@ paths: category: orgs subcategory: rules parameters: - - *141 + - *145 - name: ruleset_id description: The ID of the ruleset. in: path @@ -38678,7 +38865,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *141 + - *145 - *286 - *287 - *288 @@ -38722,7 +38909,7 @@ paths: headers: Link: *39 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38744,7 +38931,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *141 + - *145 - *78 - name: sort description: The property to sort the results by. @@ -39042,7 +39229,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *238 + items: *242 private_fork: readOnly: true nullable: true @@ -39461,7 +39648,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams parameters: - - *141 + - *145 responses: '200': description: Response @@ -39471,7 +39658,7 @@ paths: type: array items: *296 examples: - default: *253 + default: *257 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39494,8 +39681,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - - *141 - - *250 + - *145 + - *254 responses: '204': description: Response @@ -39520,8 +39707,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *141 - - *250 + - *145 + - *254 responses: '204': description: Response @@ -39547,7 +39734,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -39579,7 +39766,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - - *141 + - *145 - *18 - *20 responses: @@ -39611,7 +39798,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -39641,7 +39828,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *141 + - *145 responses: '200': description: Response @@ -39666,7 +39853,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-an-organization parameters: - - *141 + - *145 - *18 - name: page description: Page token @@ -39776,8 +39963,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *141 - - *250 + - *145 + - *254 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -39809,13 +39996,13 @@ paths: application/json: schema: type: array - items: *98 + items: *102 examples: - default: *99 + default: *103 '500': *84 '403': *29 '404': *7 - '422': *100 + '422': *104 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39849,8 +40036,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-a-team parameters: - - *141 - - *250 + - *145 + - *254 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -39882,9 +40069,9 @@ paths: application/json: schema: type: array - items: *101 + items: *105 examples: - default: *194 + default: *198 '500': *84 '401': *25 '403': *29 @@ -39906,7 +40093,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams parameters: - - *141 + - *145 - *18 - *20 responses: @@ -39916,9 +40103,9 @@ paths: application/json: schema: type: array - items: *238 + items: *242 examples: - default: *253 + default: *257 headers: Link: *39 '403': *29 @@ -39940,7 +40127,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team parameters: - - *141 + - *145 requestBody: required: true content: @@ -40075,8 +40262,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *251 - required: *252 + properties: *255 + required: *256 nullable: true members_count: type: integer @@ -40392,8 +40579,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - - *141 - - *250 + - *145 + - *254 responses: '200': description: Response @@ -40422,8 +40609,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - - *141 - - *250 + - *145 + - *254 requestBody: required: false content: @@ -40519,8 +40706,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - - *141 - - *250 + - *145 + - *254 responses: '204': description: Response @@ -40546,8 +40733,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - - *141 - - *250 + - *145 + - *254 - *78 - *18 - *20 @@ -40643,7 +40830,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *106 + reactions: *110 required: - author - body @@ -40737,8 +40924,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - - *141 - - *250 + - *145 + - *254 requestBody: required: true content: @@ -40846,8 +41033,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - - *141 - - *250 + - *145 + - *254 - &309 name: discussion_number description: The number that identifies the discussion. @@ -40884,8 +41071,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - - *141 - - *250 + - *145 + - *254 - *309 requestBody: required: false @@ -40981,8 +41168,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - - *141 - - *250 + - *145 + - *254 - *309 responses: '204': @@ -41009,8 +41196,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - - *141 - - *250 + - *145 + - *254 - *309 - *78 - *18 @@ -41079,7 +41266,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *106 + reactions: *110 required: - author - body @@ -41162,8 +41349,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *141 - - *250 + - *145 + - *254 - *309 requestBody: required: true @@ -41254,8 +41441,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *141 - - *250 + - *145 + - *254 - *309 - &312 name: comment_number @@ -41293,8 +41480,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *141 - - *250 + - *145 + - *254 - *309 - *312 requestBody: @@ -41384,8 +41571,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *141 - - *250 + - *145 + - *254 - *309 - *312 responses: @@ -41413,8 +41600,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *141 - - *250 + - *145 + - *254 - *309 - *312 - name: content @@ -41535,8 +41722,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *141 - - *250 + - *145 + - *254 - *309 - *312 requestBody: @@ -41627,8 +41814,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *141 - - *250 + - *145 + - *254 - *309 - *312 - &316 @@ -41663,8 +41850,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *141 - - *250 + - *145 + - *254 - *309 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -41719,8 +41906,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *141 - - *250 + - *145 + - *254 - *309 requestBody: required: true @@ -41785,8 +41972,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *141 - - *250 + - *145 + - *254 - *309 - *316 responses: @@ -41811,8 +41998,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team parameters: - - *141 - - *250 + - *145 + - *254 responses: '200': description: Response @@ -41839,8 +42026,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team parameters: - - *141 - - *250 + - *145 + - *254 requestBody: required: true content: @@ -41884,8 +42071,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team parameters: - - *141 - - *250 + - *145 + - *254 responses: '204': description: Response @@ -41909,8 +42096,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - - *141 - - *250 + - *145 + - *254 - *18 - *20 responses: @@ -41920,9 +42107,9 @@ paths: application/json: schema: type: array - items: *235 + items: *239 examples: - default: *236 + default: *240 headers: Link: *39 x-github: @@ -41944,8 +42131,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - - *141 - - *250 + - *145 + - *254 - name: role description: Filters members returned by their role in the team. in: query @@ -41968,7 +42155,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 x-github: @@ -41998,9 +42185,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - - *141 - - *250 - - *181 + - *145 + - *254 + - *185 responses: '200': description: Response @@ -42069,9 +42256,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *141 - - *250 - - *181 + - *145 + - *254 + - *185 requestBody: required: false content: @@ -42133,9 +42320,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - - *141 - - *250 - - *181 + - *145 + - *254 + - *185 responses: '204': description: Response @@ -42161,8 +42348,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - - *141 - - *250 + - *145 + - *254 - *18 - *20 responses: @@ -42301,8 +42488,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - - *141 - - *250 + - *145 + - *254 - &323 name: project_id description: The unique identifier of the project. @@ -42377,8 +42564,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - - *141 - - *250 + - *145 + - *254 - *323 requestBody: required: false @@ -42443,8 +42630,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - - *141 - - *250 + - *145 + - *254 - *323 responses: '204': @@ -42469,8 +42656,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - - *141 - - *250 + - *145 + - *254 - *18 - *20 responses: @@ -42480,9 +42667,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: *260 + default: *264 headers: Link: *39 x-github: @@ -42511,8 +42698,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *141 - - *250 + - *145 + - *254 - *324 - *325 responses: @@ -42543,8 +42730,8 @@ paths: title: License Simple description: License Simple type: object - properties: *119 - required: *120 + properties: *123 + required: *124 nullable: true forks: type: integer @@ -43089,8 +43276,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *141 - - *250 + - *145 + - *254 - *324 - *325 requestBody: @@ -43137,8 +43324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - - *141 - - *250 + - *145 + - *254 - *324 - *325 responses: @@ -43166,8 +43353,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team parameters: - - *141 - - *250 + - *145 + - *254 responses: '200': description: Response @@ -43197,8 +43384,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections parameters: - - *141 - - *250 + - *145 + - *254 requestBody: required: true content: @@ -43273,8 +43460,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - - *141 - - *250 + - *145 + - *254 - *18 - *20 responses: @@ -43284,7 +43471,7 @@ paths: application/json: schema: type: array - items: *238 + items: *242 examples: response-if-child-teams-exist: &656 value: @@ -43339,7 +43526,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *141 + - *145 - name: security_product in: path description: The security feature to enable or disable. @@ -44013,8 +44200,8 @@ paths: application/json: schema: oneOf: - - *144 - - *145 + - *148 + - *149 '503': description: Response content: @@ -44115,7 +44302,7 @@ paths: description: Response content: application/json: - schema: *267 + schema: *271 examples: default: &334 value: @@ -44216,7 +44403,7 @@ paths: description: Response content: application/json: - schema: *267 + schema: *271 examples: default: *334 '404': @@ -44328,7 +44515,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 '404': *7 @@ -44354,7 +44541,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#add-project-collaborator parameters: - *323 - - *181 + - *185 requestBody: required: false content: @@ -44402,7 +44589,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#remove-user-as-a-collaborator parameters: - *323 - - *181 + - *185 responses: '204': description: Response @@ -44431,7 +44618,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#get-project-permission-for-a-user parameters: - *323 - - *181 + - *185 responses: '200': description: Response @@ -46467,7 +46654,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -46577,7 +46764,7 @@ paths: description: Empty response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -46774,7 +46961,7 @@ paths: type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *42 - selected_actions_url: *152 + selected_actions_url: *156 required: - enabled examples: @@ -47000,7 +47187,7 @@ paths: description: Response content: application/json: - schema: *155 + schema: *159 examples: default: *48 x-github: @@ -47035,7 +47222,7 @@ paths: required: true content: application/json: - schema: *156 + schema: *160 examples: default: *48 x-github: @@ -47118,9 +47305,9 @@ paths: application/json: schema: type: array - items: *160 + items: *164 examples: - default: *161 + default: *165 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47186,7 +47373,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *162 + '201': *166 '404': *7 '422': *8 x-github: @@ -47225,7 +47412,7 @@ paths: application/json: schema: *58 examples: - default: *163 + default: *167 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47262,7 +47449,7 @@ paths: application/json: schema: *58 examples: - default: *164 + default: *168 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47294,7 +47481,7 @@ paths: application/json: schema: *55 examples: - default: *165 + default: *169 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47473,7 +47660,7 @@ paths: - *325 - *54 responses: - '200': *166 + '200': *170 '404': *7 x-github: githubCloudOnly: false @@ -47503,7 +47690,7 @@ paths: - *324 - *325 - *54 - - *167 + - *171 responses: '200': *60 '404': *7 @@ -47905,8 +48092,8 @@ paths: - author - committer nullable: true - repository: *159 - head_repository: *159 + repository: *163 + head_repository: *163 head_repository_id: type: integer example: 5 @@ -48592,7 +48779,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -48882,11 +49069,11 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48986,11 +49173,11 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49202,7 +49389,7 @@ paths: reviewer: anyOf: - *19 - - *238 + - *242 required: - environment - wait_timer @@ -49414,8 +49601,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 required: - id - node_id @@ -49511,7 +49698,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -49557,7 +49744,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -49800,7 +49987,7 @@ paths: parameters: - *324 - *325 - - *169 + - *173 responses: '200': description: Response @@ -49836,7 +50023,7 @@ paths: parameters: - *324 - *325 - - *169 + - *173 requestBody: required: true content: @@ -49864,7 +50051,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -49892,7 +50079,7 @@ paths: parameters: - *324 - *325 - - *169 + - *173 responses: '204': description: Response @@ -49989,7 +50176,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -50016,7 +50203,7 @@ paths: parameters: - *324 - *325 - - *172 + - *176 responses: '200': description: Response @@ -50052,7 +50239,7 @@ paths: parameters: - *324 - *325 - - *172 + - *176 requestBody: required: true content: @@ -50096,7 +50283,7 @@ paths: parameters: - *324 - *325 - - *172 + - *176 responses: '204': description: Response @@ -50703,7 +50890,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 '404': *7 @@ -51346,7 +51533,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *238 + items: *242 apps: description: The list of apps with review dismissal access. @@ -51375,7 +51562,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *238 + items: *242 apps: description: The list of apps allowed to bypass pull request requirements. @@ -51834,12 +52021,12 @@ paths: nullable: true oneOf: - *19 - - *170 + - *174 committer: nullable: true oneOf: - *19 - - *170 + - *174 parents: type: array items: @@ -52617,7 +52804,7 @@ paths: items: *19 teams: type: array - items: *238 + items: *242 apps: type: array items: *6 @@ -52635,7 +52822,7 @@ paths: items: *19 teams: type: array - items: *238 + items: *242 apps: type: array items: *6 @@ -54022,9 +54209,9 @@ paths: application/json: schema: type: array - items: *238 + items: *242 examples: - default: *253 + default: *257 '404': *7 x-github: githubCloudOnly: false @@ -54082,9 +54269,9 @@ paths: application/json: schema: type: array - items: *238 + items: *242 examples: - default: *253 + default: *257 '422': *16 x-github: githubCloudOnly: false @@ -54143,9 +54330,9 @@ paths: application/json: schema: type: array - items: *238 + items: *242 examples: - default: *253 + default: *257 '422': *16 x-github: githubCloudOnly: false @@ -54203,9 +54390,9 @@ paths: application/json: schema: type: array - items: *238 + items: *242 examples: - default: *253 + default: *257 '422': *16 x-github: githubCloudOnly: false @@ -54239,7 +54426,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 '404': *7 x-github: githubCloudOnly: false @@ -54298,7 +54485,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 '422': *16 x-github: githubCloudOnly: false @@ -54358,7 +54545,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 '422': *16 x-github: githubCloudOnly: false @@ -54418,7 +54605,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 '422': *16 x-github: githubCloudOnly: false @@ -54976,8 +55163,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests @@ -55052,8 +55239,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 required: - id - node_id @@ -55752,7 +55939,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -55888,9 +56075,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 - repository: *159 + properties: *107 + required: *108 + repository: *163 created_at: type: string format: date-time @@ -56306,7 +56493,7 @@ paths: required: - app_id - setting - repository: *159 + repository: *163 examples: default: value: @@ -56754,7 +56941,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -56783,8 +56970,8 @@ paths: parameters: - *324 - *325 - - *182 - - *183 + - *186 + - *187 - *20 - *18 - &414 @@ -56820,7 +57007,7 @@ paths: be returned. in: query required: false - schema: *184 + schema: *188 - name: severity description: If specified, only code scanning alerts with this severity will be returned. @@ -56980,7 +57167,7 @@ paths: application/json: schema: *3 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57182,7 +57369,7 @@ paths: '304': *37 '403': *411 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57315,7 +57502,7 @@ paths: application/json: schema: *3 '404': *7 - '503': *96 + '503': *100 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -57390,7 +57577,7 @@ paths: - source '403': *411 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57424,8 +57611,8 @@ paths: parameters: - *324 - *325 - - *182 - - *183 + - *186 + - *187 - *20 - *18 - *415 @@ -57565,7 +57752,7 @@ paths: warning: '' '403': *411 '404': *7 - '503': *96 + '503': *100 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -57669,7 +57856,7 @@ paths: - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 '403': *411 '404': *7 - '503': *96 + '503': *100 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -57805,7 +57992,7 @@ paths: '400': *15 '403': *420 '404': *7 - '503': *96 + '503': *100 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -57947,7 +58134,7 @@ paths: commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c '403': *411 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58023,7 +58210,7 @@ paths: description: Found '403': *411 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58056,7 +58243,7 @@ paths: description: Response '403': *420 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58510,7 +58697,7 @@ paths: content: application/json: schema: *3 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58548,7 +58735,7 @@ paths: examples: default: *425 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58708,7 +58895,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58793,7 +58980,7 @@ paths: schedule: weekly '403': *411 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58858,7 +59045,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -58891,7 +59078,7 @@ paths: content: application/json: schema: *3 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59033,7 +59220,7 @@ paths: '404': *7 '413': description: Payload Too Large if the sarif field is too large - '503': *96 + '503': *100 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -59102,7 +59289,7 @@ paths: '403': *411 '404': description: Not Found if the sarif id does not match any upload - '503': *96 + '503': *100 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -59149,7 +59336,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *187 + configuration: *191 examples: default: value: @@ -59178,7 +59365,7 @@ paths: html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 created_at: '2024-05-01T00:00:00Z' updated_at: '2024-05-01T00:00:00Z' - '204': *190 + '204': *192 '304': *37 '403': *29 '404': *7 @@ -59341,7 +59528,7 @@ paths: type: integer codespaces: type: array - items: *242 + items: *246 examples: default: value: @@ -59703,7 +59890,7 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *242 + schema: *246 examples: default: *429 '202': @@ -59711,14 +59898,14 @@ paths: being retried in the background content: application/json: - schema: *242 + schema: *246 examples: default: *429 '400': *15 '401': *25 '403': *29 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -60021,7 +60208,7 @@ paths: '403': *29 '404': *7 '422': *16 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60135,7 +60322,7 @@ paths: parameters: - *324 - *325 - - *169 + - *173 responses: '200': description: Response @@ -60165,7 +60352,7 @@ paths: parameters: - *324 - *325 - - *169 + - *173 requestBody: required: true content: @@ -60193,7 +60380,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -60219,7 +60406,7 @@ paths: parameters: - *324 - *325 - - *169 + - *173 responses: '204': description: Response @@ -60459,7 +60646,7 @@ paths: parameters: - *324 - *325 - - *181 + - *185 responses: '204': description: Response if user is a collaborator @@ -60503,7 +60690,7 @@ paths: parameters: - *324 - *325 - - *181 + - *185 requestBody: required: false content: @@ -60540,7 +60727,7 @@ paths: example: 42 type: integer format: int64 - repository: *159 + repository: *163 invitee: title: Simple User description: A GitHub user. @@ -60753,7 +60940,7 @@ paths: parameters: - *324 - *325 - - *181 + - *185 responses: '204': description: No Content when collaborator was removed from the repository. @@ -60784,7 +60971,7 @@ paths: parameters: - *324 - *325 - - *181 + - *185 responses: '200': description: if user has admin permissions @@ -60912,8 +61099,8 @@ paths: updated_at: type: string format: date-time - author_association: *105 - reactions: *106 + author_association: *109 + reactions: *110 required: - url - html_url @@ -60990,7 +61177,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 responses: '200': description: Response @@ -61057,7 +61244,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 requestBody: required: true content: @@ -61132,7 +61319,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 responses: '204': description: Response @@ -61155,7 +61342,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. @@ -61206,7 +61393,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 requestBody: required: true content: @@ -61271,7 +61458,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 - *316 responses: '204': @@ -61454,7 +61641,7 @@ paths: '500': *84 '400': *15 '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61523,7 +61710,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *16 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61821,7 +62008,7 @@ paths: nullable: true requested_teams: type: array - items: *238 + items: *242 nullable: true head: type: object @@ -61897,7 +62084,7 @@ paths: - review_comments - review_comment - self - author_association: *105 + author_association: *109 auto_merge: &549 title: Auto merge description: The status of auto merging a pull request. @@ -62441,7 +62628,7 @@ paths: draft: false headers: Link: *39 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62606,8 +62793,8 @@ paths: '422': *16 '404': *7 '500': *84 - '503': *96 - '409': *146 + '503': *100 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62994,7 +63181,7 @@ paths: type: string total_count: type: integer - repository: *159 + repository: *163 commit_url: type: string format: uri @@ -63297,8 +63484,8 @@ paths: title: License Simple description: License Simple type: object - properties: *119 - required: *120 + properties: *123 + required: *124 nullable: true contributing: title: Community Health File @@ -63761,7 +63948,7 @@ paths: module Test" '404': *7 '500': *84 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64819,8 +65006,8 @@ paths: verified_at: '422': *16 '404': *7 - '409': *146 - '503': *96 + '409': *150 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64966,18 +65153,18 @@ paths: parameters: - *324 - *325 - - *200 - - *201 - - *202 - - *203 + - *204 + - *205 + - *206 + - *207 - 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 - - *204 - - *205 + - *208 + - *209 - *78 - name: page description: "**Closing down notice**. Page number of the results to fetch. @@ -64997,8 +65184,8 @@ paths: default: 30 - *76 - *77 - - *206 - - *207 + - *210 + - *211 responses: '200': description: Response @@ -65577,7 +65764,7 @@ paths: '400': *15 '403': *29 '404': *7 - '409': *146 + '409': *150 '422': *8 x-github: githubCloudOnly: false @@ -65703,7 +65890,7 @@ paths: parameters: - *324 - *325 - - *169 + - *173 responses: '200': description: Response @@ -65737,7 +65924,7 @@ paths: parameters: - *324 - *325 - - *169 + - *173 requestBody: required: true content: @@ -65765,7 +65952,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -65791,7 +65978,7 @@ paths: parameters: - *324 - *325 - - *169 + - *173 responses: '204': description: Response @@ -66935,8 +67122,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 required: - id - node_id @@ -67349,7 +67536,7 @@ paths: reviewer: anyOf: - *19 - - *238 + - *242 required: - id - node_id @@ -68379,7 +68566,7 @@ paths: - *324 - *325 - *474 - - *169 + - *173 responses: '200': description: Response @@ -68412,7 +68599,7 @@ paths: - *324 - *325 - *474 - - *169 + - *173 requestBody: required: true content: @@ -68443,7 +68630,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -68472,7 +68659,7 @@ paths: - *324 - *325 - *474 - - *169 + - *173 responses: '204': description: Default response @@ -68571,7 +68758,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -68599,7 +68786,7 @@ paths: - *324 - *325 - *474 - - *172 + - *176 responses: '200': description: Response @@ -68630,7 +68817,7 @@ paths: parameters: - *324 - *325 - - *172 + - *176 - *474 requestBody: required: true @@ -68675,7 +68862,7 @@ paths: parameters: - *324 - *325 - - *172 + - *176 - *474 responses: '204': @@ -68709,7 +68896,7 @@ paths: application/json: schema: type: array - items: *130 + items: *134 examples: 200-response: value: @@ -68799,7 +68986,7 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: default: value: @@ -69044,7 +69231,7 @@ paths: schema: type: string '404': *7 - '409': *146 + '409': *150 '403': *29 '422': description: Validation failed @@ -69052,7 +69239,7 @@ paths: application/json: schema: oneOf: - - *144 + - *148 - *487 x-github: githubCloudOnly: false @@ -69130,7 +69317,7 @@ paths: '404': *7 '422': *16 '403': *29 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69451,7 +69638,7 @@ paths: type: string '422': *16 '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69540,7 +69727,7 @@ paths: payload: verified_at: '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69638,7 +69825,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *39 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69679,7 +69866,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69737,7 +69924,7 @@ paths: schema: type: string '422': *16 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69791,7 +69978,7 @@ paths: examples: default: *491 '422': *16 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69814,7 +70001,7 @@ paths: '204': description: Response '422': *16 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70018,7 +70205,7 @@ paths: schema: type: string '422': *16 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70080,7 +70267,7 @@ paths: examples: default: *494 '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70265,7 +70452,7 @@ paths: '422': *16 '404': *7 '403': *29 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70353,7 +70540,7 @@ paths: truncated: false '422': *16 '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70615,7 +70802,7 @@ paths: parameters: - *324 - *325 - - *215 + - *219 responses: '200': description: Response @@ -70645,7 +70832,7 @@ paths: parameters: - *324 - *325 - - *215 + - *219 requestBody: required: true content: @@ -70715,7 +70902,7 @@ paths: parameters: - *324 - *325 - - *215 + - *219 responses: '204': description: Response @@ -70741,7 +70928,7 @@ paths: parameters: - *324 - *325 - - *215 + - *219 responses: '200': description: Response @@ -70770,7 +70957,7 @@ paths: parameters: - *324 - *325 - - *215 + - *219 requestBody: required: false content: @@ -70816,9 +71003,9 @@ paths: parameters: - *324 - *325 - - *215 + - *219 - *18 - - *216 + - *220 responses: '200': description: Response @@ -70826,9 +71013,9 @@ paths: application/json: schema: type: array - items: *217 + items: *221 examples: - default: *218 + default: *222 '400': *15 '422': *16 x-github: @@ -70849,16 +71036,16 @@ paths: parameters: - *324 - *325 - - *215 + - *219 - *17 responses: '200': description: Response content: application/json: - schema: *219 + schema: *223 examples: - default: *220 + default: *224 '400': *15 '422': *16 x-github: @@ -70879,10 +71066,10 @@ paths: parameters: - *324 - *325 - - *215 + - *219 - *17 responses: - '202': *147 + '202': *151 '400': *15 '422': *16 x-github: @@ -70904,7 +71091,7 @@ paths: parameters: - *324 - *325 - - *215 + - *219 responses: '204': description: Response @@ -70931,7 +71118,7 @@ paths: parameters: - *324 - *325 - - *215 + - *219 responses: '204': description: Response @@ -71721,7 +71908,7 @@ paths: application/json: schema: anyOf: - - *233 + - *237 - type: object properties: {} additionalProperties: false @@ -71769,7 +71956,7 @@ paths: description: Response content: application/json: - schema: *233 + schema: *237 examples: default: *504 '409': @@ -71963,7 +72150,7 @@ paths: parameters: - *324 - *325 - - *237 + - *241 requestBody: required: false content: @@ -72125,7 +72312,7 @@ paths: parameters: - *324 - *325 - - *237 + - *241 responses: '204': description: Response @@ -72197,7 +72384,7 @@ paths: required: false schema: type: string - - *239 + - *243 - name: sort description: What to sort results by. in: query @@ -72210,7 +72397,7 @@ paths: - comments default: created - *78 - - *108 + - *112 - *18 - *20 responses: @@ -72220,7 +72407,7 @@ paths: application/json: schema: type: array - items: *118 + items: *122 examples: default: &516 value: @@ -72475,7 +72662,7 @@ paths: description: Response content: application/json: - schema: *118 + schema: *122 examples: default: &511 value: @@ -72631,7 +72818,7 @@ paths: '400': *15 '403': *29 '422': *16 - '503': *96 + '503': *100 '404': *7 '410': *335 x-github: @@ -72663,7 +72850,7 @@ paths: parameters: - *324 - *325 - - *128 + - *132 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -72673,7 +72860,7 @@ paths: enum: - asc - desc - - *108 + - *112 - *18 - *20 responses: @@ -72745,7 +72932,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 responses: '200': description: Response @@ -72809,7 +72996,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 requestBody: required: true content: @@ -72853,7 +73040,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 responses: '204': description: Response @@ -72875,7 +73062,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. @@ -72926,7 +73113,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 requestBody: required: true content: @@ -72991,7 +73178,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 - *316 responses: '204': @@ -73111,7 +73298,7 @@ paths: properties: *4 required: *5 nullable: true - requested_team: *238 + requested_team: *242 dismissed_review: title: Issue Event Dismissed Review type: object @@ -73176,7 +73363,7 @@ paths: required: - from - to - author_association: *105 + author_association: *109 lock_reason: type: string nullable: true @@ -73189,8 +73376,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 required: - id - node_id @@ -73627,7 +73814,7 @@ paths: description: Response content: application/json: - schema: *118 + schema: *122 examples: default: *511 '301': *338 @@ -73754,11 +73941,11 @@ paths: description: Response content: application/json: - schema: *118 + schema: *122 examples: default: *511 '422': *16 - '503': *96 + '503': *100 '403': *29 '301': *338 '404': *7 @@ -73808,7 +73995,7 @@ paths: description: Response content: application/json: - schema: *118 + schema: *122 examples: default: *511 x-github: @@ -73853,7 +74040,7 @@ paths: description: Response content: application/json: - schema: *118 + schema: *122 examples: default: *511 x-github: @@ -73922,7 +74109,7 @@ paths: - *324 - *325 - *512 - - *108 + - *112 - *18 - *20 responses: @@ -74067,8 +74254,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 label: type: object properties: @@ -74121,8 +74308,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 label: type: object properties: @@ -74210,8 +74397,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 assignee: *19 assigner: *19 required: @@ -74257,8 +74444,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 milestone: type: object properties: @@ -74308,8 +74495,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 milestone: type: object properties: @@ -74359,8 +74546,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 rename: type: object properties: @@ -74413,10 +74600,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 review_requester: *19 - requested_team: *238 + requested_team: *242 requested_reviewer: *19 required: - review_requester @@ -74460,10 +74647,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 review_requester: *19 - requested_team: *238 + requested_team: *242 requested_reviewer: *19 required: - review_requester @@ -74507,8 +74694,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 dismissed_review: type: object properties: @@ -74567,8 +74754,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 lock_reason: type: string example: '"off-topic"' @@ -74615,8 +74802,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 project_card: type: object properties: @@ -74681,8 +74868,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 project_card: type: object properties: @@ -74747,8 +74934,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 project_card: type: object properties: @@ -75473,7 +75660,7 @@ paths: description: Response content: application/json: - schema: *118 + schema: *122 examples: default: *511 headers: @@ -75520,7 +75707,7 @@ paths: application/json: schema: type: array - items: *118 + items: *122 examples: default: *516 headers: @@ -75582,7 +75769,7 @@ paths: description: Response content: application/json: - schema: *118 + schema: *122 examples: default: *511 headers: @@ -75644,13 +75831,13 @@ paths: description: Response content: application/json: - schema: *118 + schema: *122 examples: default: *511 '403': *29 '404': *7 '422': *8 - '503': *96 + '503': *100 x-github: triggersNotification: true githubCloudOnly: false @@ -75740,7 +75927,7 @@ paths: issue_url: type: string format: uri - author_association: *105 + author_association: *109 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -75750,9 +75937,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 - reactions: *106 + properties: *107 + required: *108 + reactions: *110 required: - event - actor @@ -75783,7 +75970,7 @@ paths: properties: type: type: string - issue: *118 + issue: *122 required: - event - created_at @@ -75978,7 +76165,7 @@ paths: type: string body_text: type: string - author_association: *105 + author_association: *109 required: - event - id @@ -76090,7 +76277,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *105 + author_association: *109 _links: type: object properties: @@ -76174,7 +76361,7 @@ paths: enum: - line - file - reactions: *106 + reactions: *110 body_html: type: string example: '"

comment body

"' @@ -76241,8 +76428,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 assignee: *19 required: - id @@ -76285,8 +76472,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 assignee: *19 required: - id @@ -76329,8 +76516,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 state_reason: type: string nullable: true @@ -76990,7 +77177,7 @@ paths: - *324 - *325 responses: - '202': *147 + '202': *151 '403': description: |- We will return a 403 with one of the following messages: @@ -77107,8 +77294,8 @@ paths: title: License Simple description: License Simple type: object - properties: *119 - required: *120 + properties: *123 + required: *124 nullable: true required: - _links @@ -77674,7 +77861,7 @@ paths: - *325 - *538 - *539 - - *108 + - *112 - *540 - *18 - *20 @@ -77685,7 +77872,7 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: default: *541 headers: @@ -78002,7 +78189,7 @@ paths: examples: default: *543 '422': *16 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78110,7 +78297,7 @@ paths: description: Response '422': *16 '400': *15 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78138,7 +78325,7 @@ paths: description: Response '422': *16 '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78571,7 +78758,7 @@ paths: - *325 - *546 responses: - '204': *190 + '204': *192 '404': *7 x-github: githubCloudOnly: false @@ -78828,7 +79015,7 @@ paths: description: Empty response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -78896,7 +79083,7 @@ paths: - *324 - *325 responses: - '204': *190 + '204': *192 '422': *15 x-github: githubCloudOnly: false @@ -78918,7 +79105,7 @@ paths: - *324 - *325 responses: - '204': *190 + '204': *192 '422': *15 x-github: githubCloudOnly: false @@ -78961,7 +79148,7 @@ paths: application/json: schema: type: array - items: *267 + items: *271 examples: default: value: @@ -79048,7 +79235,7 @@ paths: description: Response content: application/json: - schema: *267 + schema: *271 examples: default: *334 '401': *25 @@ -79551,7 +79738,7 @@ paths: - review_comments - review_comment - self - author_association: *105 + author_association: *109 auto_merge: *549 draft: description: Indicates whether or not the pull request is a draft. @@ -80191,7 +80378,7 @@ paths: enum: - asc - desc - - *108 + - *112 - *18 - *20 responses: @@ -80282,7 +80469,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 responses: '200': description: Response @@ -80367,7 +80554,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 requestBody: required: true content: @@ -80409,7 +80596,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 responses: '204': description: Response @@ -80432,7 +80619,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. @@ -80483,7 +80670,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 requestBody: required: true content: @@ -80548,7 +80735,7 @@ paths: parameters: - *324 - *325 - - *117 + - *121 - *316 responses: '204': @@ -80618,7 +80805,7 @@ paths: application/json: schema: *3 '500': *84 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80774,7 +80961,7 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *242 + schema: *246 examples: default: *429 '202': @@ -80782,13 +80969,13 @@ paths: being retried in the background content: application/json: - schema: *242 + schema: *246 examples: default: *429 '401': *25 '403': *29 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -80817,7 +81004,7 @@ paths: - *324 - *325 - *554 - - *128 + - *132 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -80827,7 +81014,7 @@ paths: enum: - asc - desc - - *108 + - *112 - *18 - *20 responses: @@ -81070,7 +81257,7 @@ paths: - *324 - *325 - *554 - - *117 + - *121 requestBody: required: true content: @@ -81253,7 +81440,7 @@ paths: Link: *39 '422': *16 '500': *84 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81428,7 +81615,7 @@ paths: items: *19 teams: type: array - items: *238 + items: *242 required: - users - teams @@ -82684,7 +82871,7 @@ paths: type: string body_text: type: string - author_association: *105 + author_association: *109 required: - id - node_id @@ -83203,7 +83390,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *105 + author_association: *109 _links: type: object properties: @@ -83218,7 +83405,7 @@ paths: type: string body_html: type: string - reactions: *106 + reactions: *110 side: description: The side of the first line of the range for a multi-line comment. @@ -83821,7 +84008,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *106 + reactions: *110 required: - assets_url - upload_url @@ -85617,7 +85804,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85677,7 +85864,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85779,7 +85966,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *96 + '503': *100 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -86151,7 +86338,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86229,7 +86416,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *96 + '503': *100 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -86255,7 +86442,7 @@ paths: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *96 + '503': *100 '200': description: Response content: @@ -86275,18 +86462,20 @@ paths: description: The type of scan status: type: string - description: The state of the scan. Either "completed" or - "running" + description: The state of the scan. Either "completed", + "running", or "pending" completed_at: type: string format: date-time description: The time that the scan was completed. Empty - if the scan is active + if the scan is running nullable: true started_at: type: string format: date-time - description: The time that the scan was started + description: The time that the scan was started. Empty if + the scan is pending + nullable: true pattern_update_scans: type: array items: *605 @@ -87290,7 +87479,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *144 + schema: *148 examples: invalid_state_transition: value: @@ -87325,7 +87514,7 @@ paths: - *325 - *608 responses: - '202': *147 + '202': *151 '400': *15 '403': *29 '404': *7 @@ -87508,8 +87697,8 @@ paths: - - 1302998400 - 1124 - -435 - '202': *147 - '204': *190 + '202': *151 + '204': *192 '422': description: Repository contains more than 10,000 commits x-github: @@ -87578,8 +87767,8 @@ paths: - 0 total: 89 week: 1336280400 - '202': *147 - '204': *190 + '202': *151 + '204': *192 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87680,8 +87869,8 @@ paths: a: 6898 d: 77 c: 10 - '202': *147 - '204': *190 + '202': *151 + '204': *192 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87882,7 +88071,7 @@ paths: - - 0 - 2 - 21 - '204': *190 + '204': *192 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88024,7 +88213,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 x-github: @@ -88476,9 +88665,9 @@ paths: application/json: schema: type: array - items: *238 + items: *242 examples: - default: *253 + default: *257 headers: Link: *39 '404': *7 @@ -89002,7 +89191,7 @@ paths: description: Response content: application/json: - schema: *159 + schema: *163 examples: default: value: @@ -89450,7 +89639,7 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: default: value: @@ -90786,7 +90975,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities parameters: - - *141 + - *145 - name: startIndex description: 'Used for pagination: the index of the first result to return.' in: query @@ -91106,7 +91295,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user parameters: - - *141 + - *145 responses: '201': description: Response @@ -91239,7 +91428,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - - *141 + - *145 - *636 responses: '200': @@ -91273,7 +91462,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - - *141 + - *145 - *636 responses: '200': @@ -91393,7 +91582,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - - *141 + - *145 - *636 responses: '200': @@ -91496,7 +91685,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - - *141 + - *145 - *636 responses: '204': @@ -91617,7 +91806,7 @@ paths: html_url: type: string format: uri - repository: *159 + repository: *163 score: type: number file_size: @@ -91749,7 +91938,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *96 + '503': *100 '422': *16 '403': *29 x-github: @@ -91921,7 +92110,7 @@ paths: type: string sha: type: string - repository: *159 + repository: *163 score: type: number node_id: @@ -92286,7 +92475,7 @@ paths: type: string score: type: number - author_association: *105 + author_association: *109 draft: type: boolean repository: *57 @@ -92306,9 +92495,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 - reactions: *106 + properties: *107 + required: *108 + reactions: *110 required: - assignee - closed_at @@ -92424,7 +92613,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *96 + '503': *100 '422': *16 '304': *37 '403': *29 @@ -92826,8 +93015,8 @@ paths: title: License Simple description: License Simple type: object - properties: *119 - required: *120 + properties: *123 + required: *124 nullable: true permissions: type: object @@ -93048,7 +93237,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *96 + '503': *100 '422': *16 '304': *37 x-github: @@ -93503,7 +93692,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *96 + '503': *100 '422': *16 x-github: githubCloudOnly: false @@ -94375,9 +94564,9 @@ paths: application/json: schema: type: array - items: *235 + items: *239 examples: - default: *236 + default: *240 headers: Link: *39 x-github: @@ -94426,7 +94615,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 '404': *7 @@ -94455,7 +94644,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - *646 - - *181 + - *185 responses: '204': description: if user is a member @@ -94492,7 +94681,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - *646 - - *181 + - *185 responses: '204': description: Response @@ -94532,7 +94721,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - *646 - - *181 + - *185 responses: '204': description: Response @@ -94569,7 +94758,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy parameters: - *646 - - *181 + - *185 responses: '200': description: Response @@ -94611,7 +94800,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - *646 - - *181 + - *185 requestBody: required: false content: @@ -94673,7 +94862,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - *646 - - *181 + - *185 responses: '204': description: Response @@ -94882,9 +95071,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: *260 + default: *264 headers: Link: *39 '404': *7 @@ -95289,7 +95478,7 @@ paths: application/json: schema: type: array - items: *238 + items: *242 examples: response-if-child-teams-exist: *656 headers: @@ -95759,7 +95948,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 '304': *37 '404': *7 '403': *29 @@ -95782,7 +95971,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *181 + - *185 responses: '204': description: If the user is blocked @@ -95810,7 +95999,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user parameters: - - *181 + - *185 responses: '204': description: Response @@ -95834,7 +96023,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user parameters: - - *181 + - *185 responses: '204': description: Response @@ -95883,9 +96072,9 @@ paths: type: integer codespaces: type: array - items: *242 + items: *246 examples: - default: *243 + default: *247 '304': *37 '500': *84 '401': *25 @@ -96024,7 +96213,7 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *242 + schema: *246 examples: default: *429 '202': @@ -96032,13 +96221,13 @@ paths: being retried in the background content: application/json: - schema: *242 + schema: *246 examples: default: *429 '401': *25 '403': *29 '404': *7 - '503': *96 + '503': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96188,7 +96377,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *169 + - *173 responses: '200': description: Response @@ -96224,7 +96413,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *169 + - *173 requestBody: required: true content: @@ -96269,7 +96458,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -96297,7 +96486,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *169 + - *173 responses: '204': description: Response @@ -96322,7 +96511,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *169 + - *173 responses: '200': description: Response @@ -96338,7 +96527,7 @@ paths: type: integer repositories: type: array - items: *159 + items: *163 examples: default: *660 '401': *25 @@ -96365,7 +96554,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *169 + - *173 requestBody: required: true content: @@ -96419,7 +96608,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *169 + - *173 - name: repository_id in: path required: true @@ -96452,7 +96641,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *169 + - *173 - name: repository_id in: path required: true @@ -96484,13 +96673,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *244 + - *248 responses: '200': description: Response content: application/json: - schema: *242 + schema: *246 examples: default: *429 '304': *37 @@ -96518,7 +96707,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *244 + - *248 requestBody: required: false content: @@ -96548,7 +96737,7 @@ paths: description: Response content: application/json: - schema: *242 + schema: *246 examples: default: *429 '401': *25 @@ -96572,9 +96761,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *244 + - *248 responses: - '202': *147 + '202': *151 '304': *37 '500': *84 '401': *25 @@ -96601,7 +96790,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *244 + - *248 responses: '202': description: Response @@ -96680,7 +96869,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *244 + - *248 - name: export_id in: path required: true @@ -96716,7 +96905,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *244 + - *248 responses: '200': description: Response @@ -96763,7 +96952,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *244 + - *248 requestBody: required: true content: @@ -97593,13 +97782,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *244 + - *248 responses: '200': description: Response content: application/json: - schema: *242 + schema: *246 examples: default: *429 '304': *37 @@ -97613,7 +97802,7 @@ paths: schema: *3 '403': *29 '404': *7 - '409': *146 + '409': *150 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97633,13 +97822,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *244 + - *248 responses: '200': description: Response content: application/json: - schema: *242 + schema: *246 examples: default: *429 '500': *84 @@ -97671,7 +97860,7 @@ paths: application/json: schema: type: array - items: *254 + items: *258 examples: default: &677 value: @@ -98026,7 +98215,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 '304': *37 @@ -98059,7 +98248,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 '304': *37 @@ -98081,7 +98270,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *181 + - *185 responses: '204': description: if the person is followed by the authenticated user @@ -98111,7 +98300,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user parameters: - - *181 + - *185 responses: '204': description: Response @@ -98136,7 +98325,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user parameters: - - *181 + - *185 responses: '204': description: Response @@ -98700,7 +98889,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *154 + - *158 responses: '204': description: Response @@ -98726,7 +98915,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *154 + - *158 responses: '204': description: Response @@ -98760,12 +98949,12 @@ paths: application/json: schema: anyOf: - - *233 + - *237 - type: object properties: {} additionalProperties: false examples: - default: *234 + default: *238 '204': description: Response when there are no restrictions x-github: @@ -98800,7 +98989,7 @@ paths: description: Response content: application/json: - schema: *233 + schema: *237 examples: default: value: @@ -98881,7 +99070,7 @@ paths: - closed - all default: open - - *239 + - *243 - name: sort description: What to sort results by. in: query @@ -98894,7 +99083,7 @@ paths: - comments default: created - *78 - - *108 + - *112 - *18 - *20 responses: @@ -98904,9 +99093,9 @@ paths: application/json: schema: type: array - items: *118 + items: *122 examples: - default: *240 + default: *244 headers: Link: *39 '404': *7 @@ -99192,7 +99381,7 @@ paths: - id - type - login - plan: *122 + plan: *126 required: - billing_cycle - next_billing_date @@ -99307,7 +99496,7 @@ paths: application/json: schema: type: array - items: *245 + items: *249 examples: default: value: @@ -99409,13 +99598,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *141 + - *145 responses: '200': description: Response content: application/json: - schema: *245 + schema: *249 examples: default: value: @@ -99473,7 +99662,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *141 + - *145 requestBody: required: true content: @@ -99498,7 +99687,7 @@ paths: description: Response content: application/json: - schema: *245 + schema: *249 examples: default: value: @@ -99566,7 +99755,7 @@ paths: application/json: schema: type: array - items: *247 + items: *251 examples: default: value: @@ -99819,7 +100008,7 @@ paths: description: Response content: application/json: - schema: *247 + schema: *251 examples: default: value: @@ -99999,7 +100188,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *248 + - *252 - name: exclude in: query required: false @@ -100012,7 +100201,7 @@ paths: description: Response content: application/json: - schema: *247 + schema: *251 examples: default: value: @@ -100206,7 +100395,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *248 + - *252 responses: '302': description: Response @@ -100232,7 +100421,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *248 + - *252 responses: '204': description: Response @@ -100261,7 +100450,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *248 + - *252 - *674 responses: '204': @@ -100286,7 +100475,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *248 + - *252 - *18 - *20 responses: @@ -100296,9 +100485,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: *260 + default: *264 headers: Link: *39 '404': *7 @@ -100387,7 +100576,7 @@ paths: application/json: schema: type: array - items: *254 + items: *258 examples: default: *677 '400': *678 @@ -100410,14 +100599,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *256 - - *257 + - *260 + - *261 responses: '200': description: Response content: application/json: - schema: *254 + schema: *258 examples: default: &691 value: @@ -100532,8 +100721,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *256 - - *257 + - *260 + - *261 responses: '204': description: Response @@ -100563,8 +100752,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *256 - - *257 + - *260 + - *261 - name: token description: package token schema: @@ -100596,8 +100785,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *256 - - *257 + - *260 + - *261 - *20 - *18 - name: state @@ -100617,7 +100806,7 @@ paths: application/json: schema: type: array - items: *258 + items: *262 examples: default: value: @@ -100666,15 +100855,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *256 - - *257 - - *259 + - *260 + - *261 + - *263 responses: '200': description: Response content: application/json: - schema: *258 + schema: *262 examples: default: value: @@ -100710,9 +100899,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *256 - - *257 - - *259 + - *260 + - *261 + - *263 responses: '204': description: Response @@ -100742,9 +100931,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *256 - - *257 - - *259 + - *260 + - *261 + - *263 responses: '204': description: Response @@ -100800,7 +100989,7 @@ paths: description: Response content: application/json: - schema: *267 + schema: *271 examples: default: value: @@ -101351,12 +101540,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *237 + - *241 responses: '204': description: Response '403': *29 - '409': *146 + '409': *150 '404': *7 '304': *37 x-github: @@ -101374,11 +101563,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *237 + - *241 responses: '204': description: Response - '409': *146 + '409': *150 '304': *37 '404': *7 '403': *29 @@ -102031,9 +102220,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: *260 + default: *264 headers: Link: *39 '304': *37 @@ -102146,7 +102335,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *124 + - *128 responses: '200': description: Response @@ -102263,7 +102452,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: example: ; rel="next" @@ -102291,7 +102480,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user parameters: - - *181 + - *185 responses: '200': description: Response @@ -102329,7 +102518,7 @@ paths: - *18 - *76 - *77 - - *181 + - *185 - name: subject_digest description: Subject Digest in: path @@ -102429,7 +102618,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *174 examples: default: value: @@ -102455,7 +102644,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *181 + - *185 responses: '200': description: Response @@ -102463,7 +102652,7 @@ paths: application/json: schema: type: array - items: *254 + items: *258 examples: default: *677 '403': *29 @@ -102488,7 +102677,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -102498,7 +102687,7 @@ paths: application/json: schema: type: array - items: *130 + items: *134 examples: default: value: @@ -102569,8 +102758,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *181 - - *141 + - *185 + - *145 - *18 - *20 responses: @@ -102580,7 +102769,7 @@ paths: application/json: schema: type: array - items: *130 + items: *134 examples: default: value: @@ -102659,7 +102848,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -102669,7 +102858,7 @@ paths: application/json: schema: type: array - items: *130 + items: *134 examples: default: value: @@ -102736,7 +102925,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -102748,7 +102937,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 x-github: @@ -102767,7 +102956,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows parameters: - - *181 + - *185 - *18 - *20 responses: @@ -102779,7 +102968,7 @@ paths: type: array items: *19 examples: - default: *241 + default: *245 headers: Link: *39 x-github: @@ -102798,7 +102987,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-user-follows-another-user parameters: - - *181 + - *185 - name: target_user in: path required: true @@ -102825,8 +103014,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - - *181 - - *108 + - *185 + - *112 - *18 - *20 responses: @@ -102836,9 +103025,9 @@ paths: application/json: schema: type: array - items: *109 + items: *113 examples: - default: *110 + default: *114 headers: Link: *39 '422': *16 @@ -102859,7 +103048,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -102895,7 +103084,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user parameters: - - *181 + - *185 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -102967,7 +103156,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *181 + - *185 responses: '200': description: Response @@ -102993,7 +103182,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -103041,7 +103230,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -103093,7 +103282,7 @@ paths: - nuget - container - *676 - - *181 + - *185 - *20 - *18 responses: @@ -103103,7 +103292,7 @@ paths: application/json: schema: type: array - items: *254 + items: *258 examples: default: *677 '403': *29 @@ -103128,15 +103317,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *256 - - *257 - - *181 + - *260 + - *261 + - *185 responses: '200': description: Response content: application/json: - schema: *254 + schema: *258 examples: default: *691 x-github: @@ -103159,9 +103348,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *256 - - *257 - - *181 + - *260 + - *261 + - *185 responses: '204': description: Response @@ -103193,9 +103382,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *256 - - *257 - - *181 + - *260 + - *261 + - *185 - name: token description: package token schema: @@ -103227,9 +103416,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *256 - - *257 - - *181 + - *260 + - *261 + - *185 responses: '200': description: Response @@ -103237,7 +103426,7 @@ paths: application/json: schema: type: array - items: *258 + items: *262 examples: default: value: @@ -103295,16 +103484,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-a-user parameters: - - *256 - - *257 - - *259 - - *181 + - *260 + - *261 + - *263 + - *185 responses: '200': description: Response content: application/json: - schema: *258 + schema: *262 examples: default: value: @@ -103339,10 +103528,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *256 - - *257 - - *181 - - *259 + - *260 + - *261 + - *185 + - *263 responses: '204': description: Response @@ -103374,10 +103563,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *256 - - *257 - - *181 - - *259 + - *260 + - *261 + - *185 + - *263 responses: '204': description: Response @@ -103400,7 +103589,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-user-projects parameters: - - *181 + - *185 - name: state description: Indicates the state of the projects to return. in: query @@ -103421,7 +103610,7 @@ paths: application/json: schema: type: array - items: *267 + items: *271 examples: default: value: @@ -103480,7 +103669,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -103490,7 +103679,7 @@ paths: application/json: schema: type: array - items: *130 + items: *134 examples: default: value: @@ -103569,7 +103758,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-received-by-a-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -103579,7 +103768,7 @@ paths: application/json: schema: type: array - items: *130 + items: *134 examples: default: value: @@ -103656,7 +103845,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user parameters: - - *181 + - *185 - name: type description: Limit results to repositories of the specified type. in: query @@ -103699,9 +103888,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: *260 + default: *264 headers: Link: *39 x-github: @@ -103725,7 +103914,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *181 + - *185 responses: '200': description: Response @@ -103755,7 +103944,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *181 + - *185 responses: '200': description: Response @@ -103785,7 +103974,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *181 + - *185 responses: '200': description: Response @@ -103811,7 +104000,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -103843,7 +104032,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -103879,7 +104068,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *181 + - *185 - *693 - *78 - *18 @@ -103915,7 +104104,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *181 + - *185 - *18 - *20 responses: @@ -103925,9 +104114,9 @@ paths: application/json: schema: type: array - items: *159 + items: *163 examples: - default: *260 + default: *264 headers: Link: *39 x-github: @@ -104218,8 +104407,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *119 - required: *120 + properties: *123 + required: *124 nullable: true organization: title: Simple User @@ -106571,8 +106760,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 check_suite: description: A suite of checks performed on the code of a given code change @@ -106621,7 +106810,7 @@ x-webhooks: pull_requests: type: array items: *394 - repository: *159 + repository: *163 status: example: completed type: string @@ -112432,7 +112621,7 @@ x-webhooks: type: string enum: - created - definition: *268 + definition: *96 enterprise: *695 installation: *696 organization: *697 @@ -112599,7 +112788,7 @@ x-webhooks: type: string enum: - updated - definition: *268 + definition: *96 enterprise: *695 installation: *696 organization: *697 @@ -123228,8 +123417,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *103 - required: *104 + properties: *107 + required: *108 reactions: title: Reactions type: object @@ -218109,12 +218298,12 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *118 + parent_issue: *122 parent_issue_repo: *57 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *118 + sub_issue: *122 installation: *696 organization: *697 repository: *698 @@ -218201,12 +218390,12 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *118 + parent_issue: *122 parent_issue_repo: *57 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *118 + sub_issue: *122 installation: *696 organization: *697 reposit{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}