diff --git a/content/account-and-profile/how-tos/email-preferences/setting-your-commit-email-address.md b/content/account-and-profile/how-tos/email-preferences/setting-your-commit-email-address.md index 1421ba4abaaf..f9b55f939083 100644 --- a/content/account-and-profile/how-tos/email-preferences/setting-your-commit-email-address.md +++ b/content/account-and-profile/how-tos/email-preferences/setting-your-commit-email-address.md @@ -86,4 +86,4 @@ You can change the email address associated with commits you make in a single re For reference information, see [AUTOTITLE](/account-and-profile/reference/email-addresses-reference). -To learn more about using a private email address, see [AUTOTITLE](/account-and-profile/reference/email-addresses-reference#your-noreply-email-address). +For more information about setting your Git username, see [AUTOTITLE](/get-started/git-basics/setting-your-username-in-git). diff --git a/content/actions/concepts/security/openid-connect.md b/content/actions/concepts/security/openid-connect.md index 553fced06f68..182e782e4e8c 100644 --- a/content/actions/concepts/security/openid-connect.md +++ b/content/actions/concepts/security/openid-connect.md @@ -166,6 +166,8 @@ You can use the `repo_property_*` claims in your cloud provider's trust conditio {% endif %} +{% ifversion dependabot-oidc-support %} + ## OIDC support for {% data variables.product.prodname_dependabot %} {% data variables.product.prodname_dependabot %} can use OIDC to authenticate with private registries, eliminating the need to store long-lived credentials as repository secrets. With OIDC-based authentication, {% data variables.product.prodname_dependabot %} update jobs can dynamically obtain short-lived credentials from your cloud identity provider. @@ -180,6 +182,8 @@ The benefits of OIDC authentication for {% data variables.product.prodname_depen For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#using-oidc-for-authentication). +{% endif %} + ## Next steps For more information about configuring OIDC, see [AUTOTITLE](/actions/how-tos/security-for-github-actions/security-hardening-your-deployments). diff --git a/content/actions/reference/workflows-and-actions/contexts.md b/content/actions/reference/workflows-and-actions/contexts.md index f31ff5971e91..7b9ddb2315cd 100644 --- a/content/actions/reference/workflows-and-actions/contexts.md +++ b/content/actions/reference/workflows-and-actions/contexts.md @@ -174,7 +174,7 @@ The `github` context contains information about the workflow run and the event t |---------------|------|-------------| | `github` | `object` | The top-level context available during any job or step in a workflow. This object contains all the properties listed below. | | `github.action` | `string` | The name of the action currently running, or the [`id`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsid) of a step. {% data variables.product.prodname_dotcom %} removes special characters, and uses the name `__run` when the current step runs a script without an `id`. If you use the same action more than once in the same job, the name will include a suffix with the sequence number with underscore before it. For example, the first script you run will have the name `__run`, and the second script will be named `__run_2`. Similarly, the second invocation of `actions/checkout` will be `actionscheckout2`. | -| `github.action_path` | `string` | The path where an action is located. This property is only supported in composite actions. You can use this path to access files located in the same repository as the action, for example by changing directories to the path (using the corresponding enviroment variable): {% raw %} `cd "$GITHUB_ACTION_PATH"` {% endraw %}. For more information on evironment variables, see [AUTOTITLE](/actions/reference/security/secure-use#use-an-intermediate-environment-variable). | +| `github.action_path` | `string` | The path where an action is located. This property is only supported in composite actions. You can use this path to access files located in the same repository as the action, for example by changing directories to the path (using the corresponding environment variable): {% raw %} `cd "$GITHUB_ACTION_PATH"` {% endraw %}. For more information on environment variables, see [AUTOTITLE](/actions/reference/security/secure-use#use-an-intermediate-environment-variable). | | `github.action_ref` | `string` | For a step executing an action, this is the ref of the action being executed. For example, `v2`.

{% data reusables.actions.composite-actions-unsupported-refs %} | | `github.action_repository` | `string` | For a step executing an action, this is the owner and repository name of the action. For example, `actions/checkout`.

{% data reusables.actions.composite-actions-unsupported-refs %} | | `github.action_status` | `string` | For a composite action, the current result of the composite action. | diff --git a/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md b/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md index eba0732e0b8c..4c580a6f942e 100644 --- a/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md +++ b/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md @@ -76,6 +76,8 @@ Before you require secure methods of two-factor authentication, we recommend not You can use a SSH certificate authority (CA) to allow members of any organization owned by your enterprise to access that organization's repositories using SSH certificates you provide. {% ifversion ssh-user-ca %}{% ifversion ghec %}If your enterprise uses {% data variables.product.prodname_emus %}, enterprise{% elsif ghes %}Enterprise{% endif %} members can also be allowed to use the certificate to access personally-owned repositories.{% endif %} {% data reusables.organizations.can-require-ssh-cert %} For more information, see [AUTOTITLE](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities). +{% data variables.product.github %} uses OpenSSH-format SSH user certificates to authenticate Git operations over SSH by validating the certificate's signature and fields (including its validity period) against a trusted SSH certificate authority (CA) configured at the organization and/or enterprise level. + {% data reusables.organizations.add-extension-to-cert %} ### Adding an SSH certificate authority @@ -104,7 +106,9 @@ You can enable or disable access to user-owned repositories with an SSH certific ### Deleting an SSH certificate authority -Deleting a CA cannot be undone. If you want to use the same CA in the future, you'll need to upload the CA again. +Deleting an SSH certificate authority (CA) from your enterprise settings on {% data variables.product.github %} can't be undone. If you want to trust the same CA again in the future, you'll need to add the CA back to {% data variables.product.github %} by uploading the CA's public key again in your enterprise's SSH certificate authority settings. + +Deleting a CA immediately prevents {% data variables.product.github %} from accepting SSH certificates signed by that CA, including certificates that have not yet expired. For CA rotation guidance, see [AUTOTITLE](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities#certificate-revocation-and-ca-rotation). {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} diff --git a/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-google-cloud-storage.md b/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-google-cloud-storage.md index db5885c5ba11..aed382aeee0c 100644 --- a/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-google-cloud-storage.md +++ b/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-google-cloud-storage.md @@ -27,6 +27,9 @@ Before enabling {% data variables.product.prodname_actions %}, make sure you hav {% data reusables.actions.enterprise-common-prereqs %} {% data reusables.actions.enterprise-oidc-prereqs %} +> [!WARNING] +> The GCS bucket used for {% data variables.product.prodname_actions %} blob storage must use Google-managed encryption keys. Customer-Managed Encryption Keys (CMEK) are not currently supported and will cause {% data variables.product.prodname_actions %} database migrations to fail with a hash mismatch error. This restriction applies only to the {% data variables.product.prodname_actions %} blob storage bucket; CMEK may still be used on VM disks and other GCP resources. + ## Enabling {% data variables.product.prodname_actions %} with Google Cloud Storage using OIDC (recommended) To configure {% data variables.product.prodname_ghe_server %} to use OIDC with Google Cloud Storage, you must first create a Google Cloud service account, then create a Google Cloud identity pool and identity provider, and finally configure {% data variables.product.prodname_ghe_server %} to use the provider and service account to access your Google Cloud Storage bucket. diff --git a/content/code-security/concepts/secret-security/about-alerts.md b/content/code-security/concepts/secret-security/about-alerts.md index a653f3ecedbf..38b76ce54a8f 100644 --- a/content/code-security/concepts/secret-security/about-alerts.md +++ b/content/code-security/concepts/secret-security/about-alerts.md @@ -20,7 +20,7 @@ contentType: concepts ## About {% ifversion fpt or ghec %}user alerts {% else %}{% data variables.secret-scanning.alerts %}{% endif %} -{% data reusables.secret-scanning.secret-scanning-about-alerts %} {% data reusables.secret-scanning.repository-alert-location %} +{% data reusables.secret-scanning.secret-scanning-about-alerts %} {% data reusables.secret-scanning.repository-alert-location %} If the same secret appears multiple times within a single file, only one alert is created. To help you triage alerts more effectively, {% data variables.product.company_short %} separates alerts into two lists: diff --git a/content/code-security/concepts/supply-chain-security/about-dependabot-alerts.md b/content/code-security/concepts/supply-chain-security/about-dependabot-alerts.md index 099990aba0b3..a1d56cc18a12 100644 --- a/content/code-security/concepts/supply-chain-security/about-dependabot-alerts.md +++ b/content/code-security/concepts/supply-chain-security/about-dependabot-alerts.md @@ -54,9 +54,25 @@ See [AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-dependab ## Alert ownership and assignments -Users with write access or higher can assign {% data variables.product.prodname_dependabot_alerts %} to repository collaborators, teams, or {% data variables.product.prodname_copilot_short %} to establish clear ownership for vulnerability remediation. Assignments help track who's responsible for each alert and prevent vulnerabilities from being overlooked. +Users with write access or higher can assign {% data variables.product.prodname_dependabot_alerts %} to repository collaborators, teams, or AI agents to establish clear ownership for vulnerability remediation. Assignments help track who's responsible for each alert and prevent vulnerabilities from being overlooked. -When an alert is assigned, the assignee receives a notification and the alert displays their name in the alert list. You can filter alerts by assignee to track progress. Assigning an alert to {% data variables.product.prodname_copilot_short %} automatically generates a fix and opens a draft pull request for review. +You can assign alerts to the following types of agents: + +* **{% data variables.product.prodname_copilot_short %}**, {% data variables.product.github %}'s built-in AI agent. +* **Third-party agents**,such as Codex or Claude, when enabled in your repository settings. + +When an alert is assigned to a person or team, the assignee receives a notification and the alert displays their name in the alert list. You can filter alerts by assignee to track progress. + +When an alert is assigned to an agent, the agent automatically creates a session and opens a draft pull request with a proposed fix. If the agent can't generate a fix, it remains as an assignee, and you can click **View Session** on the alert timeline to review the agent's log. + +> [!NOTE] +> Assignment visibility is currently scoped to the repository-level alerts view. The organization-wide security overview does not display alert assignments. + +When an alert's assignees change, {% data variables.product.github %} sends an `assignees_changed` webhook event. You can use this event to trigger workflows or sync assignment data with external systems. For more information, see [AUTOTITLE](/webhooks/webhook-events-and-payloads#dependabot_alert). + +### Automation and integrations + +You can manage alert assignments programmatically using the REST API. For more information, see [AUTOTITLE](/rest/dependabot/alerts). For information about assigning alerts, see [AUTOTITLE](/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/viewing-and-updating-dependabot-alerts#viewing-and-prioritizing-dependabot-alerts). diff --git a/content/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/viewing-and-updating-dependabot-alerts.md b/content/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/viewing-and-updating-dependabot-alerts.md index 54ce0f72dfd4..c6b2f833cf82 100644 --- a/content/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/viewing-and-updating-dependabot-alerts.md +++ b/content/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/viewing-and-updating-dependabot-alerts.md @@ -38,6 +38,12 @@ By default, alerts are sorted by **Most important**, which helps you prioritize {% data reusables.dependabot.where-to-view-dependabot-alerts %} +{% ifversion dependabot-alerts-assignees %} + +When you assign an alert to an AI agent, the agent automatically creates a session and opens a draft pull request with a proposed fix. If the agent can't generate a fix, it remains as an assignee of the alert. You can click **View Session** on the alert timeline to review the agent's log and understand why no pull request was created. Only a user can remove the agent as an assignee. + +{% endif %} + {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-dependabot-alerts %} @@ -58,7 +64,14 @@ By default, alerts are sorted by **Most important**, which helps you prioritize ![Screenshot showing the "Tags" section in the alert details page.](/assets/images/help/repository/dependabot-alerts-tags-section.png) {% ifversion dependabot-alerts-assignees %} -1. On the right panel, select an assignee by using the **Assignees** dropdown list. You can assign the alert to a user or team to establish clear ownership, or assign it to {% data variables.product.prodname_copilot_short %} to automatically generate a fix. This clearly communicates who is responsible for triaging the alert and helps you avoid repetitive analysis. It also ensures that alerts are not missed. +1. On the right panel, assign ownership for the alert: + * Click the {% octicon "gear" aria-label="Show options" %} dropdown menu next to "Assignees" to select a user, team, or AI agent from the list. You can also click **Assign to Agent** to assign directly to an agent. + + When you assign an alert to an agent, a dialog appears where you can optionally: + * Add a custom prompt with additional context about the fix. + * Select a different repository. + * Select the AI model to use. + * Select a custom agent you have configured (recommended for specialized tasks). {% endif %} 1. Optionally, to suggest an improvement to the related security advisory, on the right-hand side of the alert details page, click **Suggest improvements for this advisory on the {% data variables.product.prodname_advisory_database %}**. See [AUTOTITLE](/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/editing-security-advisories-in-the-github-advisory-database). diff --git a/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configuring-access-to-private-registries-for-dependabot.md b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configuring-access-to-private-registries-for-dependabot.md index 7193aa093447..752fe79154d9 100644 --- a/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configuring-access-to-private-registries-for-dependabot.md +++ b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configuring-access-to-private-registries-for-dependabot.md @@ -124,6 +124,8 @@ If your private registry is configured with an IP allow list, you can find the I {% endif %} +{% ifversion dependabot-oidc-support %} + ## Using OIDC for authentication {% data variables.product.prodname_dependabot %} can use OpenID Connect (OIDC) to authenticate with private registries, eliminating the need to store long-lived credentials as repository secrets. @@ -191,6 +193,8 @@ registries: For more information about how OIDC works, see [AUTOTITLE](/actions/concepts/security/openid-connect). +{% endif %} + ## Allowing external code execution When you give {% data variables.product.prodname_dependabot %} access to one or more registries, external code execution is automatically disabled to protect your code from compromised packages. However, some version updates may fail. @@ -430,6 +434,8 @@ registries: {% endraw %} +{% ifversion dependabot-oidc-support %} + You can also use OIDC authentication to access JFrog Artifactory. {% data reusables.dependabot.dependabot-oidc-credentials %} {% raw %} @@ -446,6 +452,8 @@ registries: {% endraw %} +{% endif %} + ### `npm-registry` The `npm-registry` type supports username and password, or token. {% data reusables.dependabot.password-definition %} @@ -516,6 +524,8 @@ registries: {% endraw %} +{% ifversion dependabot-oidc-support %} + You can also use OIDC authentication to access Azure DevOps Artifacts. {% data reusables.dependabot.dependabot-oidc-credentials %} {% raw %} @@ -533,6 +543,8 @@ registries: The `AZURE_TENANT_ID` and `AZURE_CLIENT_ID` values can be obtained from the overview page of your Entra ID app registration. +{% endif %} + ### `pub-repository` The `pub-repository` type supports a URL and a token. @@ -590,6 +602,8 @@ registries: {% endraw %} +{% ifversion dependabot-oidc-support %} + You can also use OIDC authentication to access Azure DevOps Artifacts. {% data reusables.dependabot.dependabot-oidc-credentials %} {% raw %} @@ -606,6 +620,8 @@ registries: {% endraw %} +{% endif %} + ### `rubygems-server` The `rubygems-server` type supports username and password, or token. {% data reusables.dependabot.password-definition %} diff --git a/content/code-security/reference/supply-chain-security/dependabot-options-reference.md b/content/code-security/reference/supply-chain-security/dependabot-options-reference.md index 9e6fe24b0bdd..2b2d74225fd6 100644 --- a/content/code-security/reference/supply-chain-security/dependabot-options-reference.md +++ b/content/code-security/reference/supply-chain-security/dependabot-options-reference.md @@ -980,6 +980,8 @@ updates: The parameters used to provide authentication details for access to a private registry vary according to the registry `type`. +{% ifversion dependabot-oidc-support %} + | Registry `type` | Required authentication parameters | |--|--| | `cargo-registry` | `token` | @@ -996,13 +998,37 @@ The parameters used to provide authentication details for access to a private re | `rubygems-server` | `username` and `password`
or `token`
or OIDC with `tenant-id` and `client-id` | | `terraform-registry` | `token` | +{% else %} + +| Registry `type` | Required authentication parameters | +|--|--| +| `cargo-registry` | `token` | +| `composer-repository` | `username` and `password` | +| `docker-registry` | `username` and `password` | +| `git` | `username` and `password` | +| `hex-organization` | `organization` and `key` | +| `hex-repository` | `repo` and `auth-key` optionally with the corresponding `public-key-fingerprint` | +| `maven-repository` | `username` and `password` | +| `npm-registry` | `username` and `password`
or `token` | +| `nuget-feed` | `username` and `password`
or `token` | +| `pub-registry` | `token` | +| `python-index` | `username` and `password`
or `token` | +| `rubygems-server` | `username` and `password`
or `token` | +| `terraform-registry` | `token` | + +{% endif %} + All sensitive data used for authentication should be stored securely and referenced from that secure location, see [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configuring-access-to-private-registries-for-dependabot). > [!TIP] > {% data reusables.dependabot.password-definition %} +{% ifversion dependabot-oidc-support %} + For more information about OIDC support for {% data variables.product.prodname_dependabot %}, see [AUTOTITLE](/actions/concepts/security/openid-connect#oidc-support-for-dependabot) and [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configuring-access-to-private-registries-for-dependabot#using-oidc-for-authentication). +{% endif %} + ### `url` and `replaces-base` The `url` parameter defines where to access a registry. When the optional `replaces-base` parameter is enabled (`true`), {% data variables.product.prodname_dependabot %} resolves dependencies using the value of `url` rather than the base URL of that specific ecosystem. diff --git a/content/copilot/concepts/agents/cloud-agent/about-cloud-agent.md b/content/copilot/concepts/agents/cloud-agent/about-cloud-agent.md index 33ff981c73f5..00211cc19994 100644 --- a/content/copilot/concepts/agents/cloud-agent/about-cloud-agent.md +++ b/content/copilot/concepts/agents/cloud-agent/about-cloud-agent.md @@ -40,7 +40,7 @@ With {% data variables.copilot.copilot_cloud_agent %}, {% data variables.product When you delegate tasks to {% data variables.copilot.copilot_cloud_agent %}, you can: * Use the agents panel or other agents entry points on {% data variables.product.prodname_dotcom_the_website %} to have {% data variables.product.prodname_copilot_short %} research, plan, and make code changes on a branch, then iterate before creating a pull request. You can also specify in your prompt that you want a pull request created right away. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/research-plan-iterate). -* Ask {% data variables.product.prodname_copilot_short %} to open a new pull request from other entry points, including {% data variables.product.prodname_github_issues %} and {% data variables.product.prodname_vscode %}. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr). +* Ask {% data variables.product.prodname_copilot_short %} to open a new pull request from other entry points, including {% data variables.product.prodname_github_issues %} and {% data variables.product.prodname_vscode %}. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions). * Mention `@copilot` in a comment on an existing pull request to ask it to make changes. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/make-changes-to-an-existing-pr). {% ifversion security-campaigns-assign-to-cca %}* Assign security alerts to {% data variables.product.prodname_copilot_short %} from security campaigns. See [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/fixing-alerts-in-security-campaign#assigning-alerts-to-copilot-cloud-agent).{% endif %} diff --git a/content/copilot/concepts/agents/cloud-agent/agent-management.md b/content/copilot/concepts/agents/cloud-agent/agent-management.md index ebfe2aeb88ad..ce68abff5526 100644 --- a/content/copilot/concepts/agents/cloud-agent/agent-management.md +++ b/content/copilot/concepts/agents/cloud-agent/agent-management.md @@ -34,7 +34,7 @@ To learn more about {% data variables.copilot.copilot_cloud_agent %}, see [AUTOT From the Agents tab, you can: -* **Kick off new agent tasks**: Select an AI model of your choice, and optionally choose from third-party agents or {% data variables.copilot.custom_agents_short %} best suited for the task. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr). +* **Kick off new agent tasks**: Select an AI model of your choice, and optionally choose from third-party agents or {% data variables.copilot.custom_agents_short %} best suited for the task. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions). * **Monitor live session logs**: Once the agent starts working, you can click any agent session to open the session log and follow its progress and thought process in real time. * **Track active sessions**: You can view all active agent sessions that have been started in the repository. * **Steer agents mid-session**: If you realize you didn't scope a request correctly, or want the agent to use a specific tool or service, you can step in and provide **steering input** without stopping the run. Steering uses **one premium request** per message. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions#steering-a-copilot-session-from-the-agents-tab). diff --git a/content/copilot/get-started/plans.md b/content/copilot/get-started/plans.md index 68ba6d14d3c2..afaaa8401a68 100644 --- a/content/copilot/get-started/plans.md +++ b/content/copilot/get-started/plans.md @@ -20,7 +20,8 @@ category: > [!IMPORTANT] -> {% data reusables.copilot.plans.individual-plans-paused %} +> * {% data reusables.copilot.plans.individual-plans-paused %} +> * {% data reusables.copilot.plans.organization-plans-paused %} {% data variables.product.company_short %} offers several plans for {% data variables.product.prodname_copilot %}, depending on your needs and whether you're using {% data variables.product.prodname_copilot_short %} as an individual or as part of an organization or enterprise. @@ -51,7 +52,8 @@ For more information, see [AUTOTITLE](/copilot/about-github-copilot/github-copil Start using {% data variables.product.prodname_copilot_short %} by signing up for the plan that best fits your needs. > [!IMPORTANT] -> {% data reusables.copilot.plans.individual-plans-paused %} +> * {% data reusables.copilot.plans.individual-plans-paused %} +> * {% data reusables.copilot.plans.organization-plans-paused %} * **{% data variables.copilot.copilot_free_short %}** — Try {% data variables.product.prodname_copilot_short %} with limited features and requests. [Start using {% data variables.copilot.copilot_free_short %}](https://github.com/copilot?ref_product=copilot&ref_type=engagement&ref_style=text&ref_plan=free). diff --git a/content/copilot/get-started/what-is-github-copilot.md b/content/copilot/get-started/what-is-github-copilot.md index 37d1d3b3f85b..95697fef4694 100644 --- a/content/copilot/get-started/what-is-github-copilot.md +++ b/content/copilot/get-started/what-is-github-copilot.md @@ -76,6 +76,9 @@ See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subs ### Organizations and enterprises +>[!IMPORTANT] +> {% data reusables.copilot.plans.organization-plans-paused %} + **Organization owners** can get {% data variables.copilot.copilot_business_short %} for their team through an enterprise account. If you don't already have an enterprise account, you can create one specifically for managing {% data variables.copilot.copilot_business_short %} licenses. See [AUTOTITLE](/copilot/concepts/about-enterprise-accounts-for-copilot-business). If your organization is owned by an enterprise that has a {% data variables.product.prodname_copilot_short %} subscription, you can ask your enterprise owner to enable {% data variables.product.prodname_copilot_short %} for your organization. Go to [https://github.com/settings/copilot](https://github.com/settings/copilot) and request access under "Get {% data variables.product.prodname_copilot_short %} from an organization." diff --git a/content/copilot/how-tos/copilot-cli/set-up-copilot-cli/authenticate-copilot-cli.md b/content/copilot/how-tos/copilot-cli/set-up-copilot-cli/authenticate-copilot-cli.md index 35b3b19c223a..9ff17c4c67aa 100644 --- a/content/copilot/how-tos/copilot-cli/set-up-copilot-cli/authenticate-copilot-cli.md +++ b/content/copilot/how-tos/copilot-cli/set-up-copilot-cli/authenticate-copilot-cli.md @@ -53,7 +53,7 @@ Offline mode is **only fully air-gapped** if your BYOK provider is local or othe | Token type | Prefix | Supported | Notes | |----------------------------|---------------|-----------|--------------------------------------------------------| | OAuth token (device flow) | `gho_` | Yes | Default method via `copilot login` | -| Fine-grained PAT | `github_pat_` | Yes | Must include required permissions **Copilot Requests** | +| Fine-grained PAT | `github_pat_` | Yes | Must be owned by your personal account (not an organization) with the **{% data variables.product.prodname_copilot_short %} Requests** account permission | | GitHub App user-to-server | `ghu_` | Yes | Via environment variable | | Classic PAT | `ghp_` | No | Not supported by {% data variables.copilot.copilot_cli_short %} | diff --git a/content/copilot/how-tos/copilot-cli/set-up-copilot-cli/troubleshoot-copilot-cli-auth.md b/content/copilot/how-tos/copilot-cli/set-up-copilot-cli/troubleshoot-copilot-cli-auth.md index 5f208480fcf8..8a8fca93dd22 100644 --- a/content/copilot/how-tos/copilot-cli/set-up-copilot-cli/troubleshoot-copilot-cli-auth.md +++ b/content/copilot/how-tos/copilot-cli/set-up-copilot-cli/troubleshoot-copilot-cli-auth.md @@ -102,7 +102,7 @@ The token was revoked, has expired, or was created without the required permissi ### Fix -Review the token's status and permissions on {% data variables.product.prodname_dotcom %}. The token must have the **Copilot Requests** permission. Generate a new token with the required permissions if necessary. +Review the token's status and permissions on {% data variables.product.prodname_dotcom %}. The token must be a {% data variables.product.pat_v2 %} owned by your **personal account** (not an organization) with the **{% data variables.product.prodname_copilot_short %} Requests** permission. Generate a new token with the required permissions if necessary. ## {% data variables.product.pat_classic_caps %} rejected diff --git a/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview.md b/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview.md index 94e0c6ff4317..14c3fdf40d37 100644 --- a/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview.md +++ b/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview.md @@ -14,7 +14,7 @@ This quickstart walks you through customizing {% data variables.product.prodname ## Prerequisites -* A {% data variables.product.prodname_copilot_short %} plan that includes {% data variables.copilot.copilot_cloud_agent %} ({% data variables.copilot.copilot_pro_plus %}, {% data variables.copilot.copilot_business_short %}, or {% data variables.copilot.copilot_enterprise_short %}). For more information, see [AUTOTITLE](/copilot/about-github-copilot/subscription-plans-for-github-copilot). +* A {% data variables.product.prodname_copilot_short %} plan that includes {% data variables.copilot.copilot_cloud_agent %} ({% data variables.copilot.copilot_pro_short %}, {% data variables.copilot.copilot_pro_plus_short %}, {% data variables.copilot.copilot_business_short %}, or {% data variables.copilot.copilot_enterprise_short %}). For more information, see [AUTOTITLE](/copilot/about-github-copilot/subscription-plans-for-github-copilot). * {% data variables.copilot.copilot_cloud_agent_short_cap_c %} enabled for your organization or account. For more information, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/access-management). * Write access to a {% data variables.product.github %} repository. diff --git a/content/copilot/how-tos/use-copilot-agents/cloud-agent/changing-the-ai-model.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/changing-the-ai-model.md index bde97aa16dbc..34c4a3dae761 100644 --- a/content/copilot/how-tos/use-copilot-agents/cloud-agent/changing-the-ai-model.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/changing-the-ai-model.md @@ -23,7 +23,7 @@ In supported entrypoints, you can select the model used by {% data variables.cop You may find that different models perform better, or provide more useful responses, depending on the type of tasks you give {% data variables.product.prodname_copilot_short %}. > [!NOTE] -> Model selection for {% data variables.copilot.copilot_cloud_agent %} is only supported when assigning an issue to {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %}, when mentioning `@copilot` in a pull request comment on {% data variables.product.prodname_dotcom_the_website %}, or when starting a task from the agents tab, agents panel, {% data variables.product.prodname_mobile %} or the Raycast launcher. Where a model picker is not available, Auto will be used automatically. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr). +> Model selection for {% data variables.copilot.copilot_cloud_agent %} is only supported when assigning an issue to {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %}, when mentioning `@copilot` in a pull request comment on {% data variables.product.prodname_dotcom_the_website %}, or when starting a task from the agents tab, agents panel, {% data variables.product.prodname_mobile %} or the Raycast launcher. Where a model picker is not available, Auto will be used automatically. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions). ## Supported models diff --git a/content/copilot/how-tos/use-copilot-agents/cloud-agent/index.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/index.md index 02ba41d9de7b..3079c2e399eb 100644 --- a/content/copilot/how-tos/use-copilot-agents/cloud-agent/index.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/index.md @@ -6,7 +6,7 @@ intro: 'Find out how {% data variables.product.prodname_copilot_short %} can res versions: feature: copilot children: - - /create-a-pr + - /start-copilot-sessions - /track-copilot-sessions - /integrate-cloud-agent-with-jira - /integrate-cloud-agent-with-slack diff --git a/content/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions.md similarity index 90% rename from content/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions.md index 5a919ad1a789..44999330a428 100644 --- a/content/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions.md @@ -1,11 +1,12 @@ --- -title: Asking GitHub Copilot to create a pull request -shortTitle: Create a PR -intro: 'You can ask {% data variables.product.prodname_copilot_short %} to create a pull request from many places, including {% data variables.product.prodname_github_issues %}, the agents panel, {% data variables.copilot.copilot_chat_short %}, the {% data variables.product.prodname_cli %}, and agentic coding tools and IDEs with Model Context Protocol (MCP) support.' +title: Starting GitHub Copilot sessions +shortTitle: Start Copilot sessions +intro: 'You can start {% data variables.copilot.copilot_cloud_agent %} from many places, including the agents tab or panel on {% data variables.product.github %}, {% data variables.product.prodname_github_issues %}, {% data variables.copilot.copilot_chat_short %}, and IDEs like {% data variables.product.prodname_vscode %}.' product: '{% data reusables.gated-features.copilot-cloud-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: feature: copilot redirect_from: + - /copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr - /copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/asking-copilot-to-create-a-pull-request - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/asking-copilot-to-create-a-pull-request @@ -31,25 +32,34 @@ category: ## Introduction -You can ask {% data variables.product.prodname_copilot_short %} to create a new pull request from: +You can start {% data variables.copilot.copilot_cloud_agent %} from: * {% data variables.product.prodname_github_issues %}, by [assigning an issue to {% data variables.product.prodname_copilot_short %}](#assigning-an-issue-to-copilot) -* The [agents tab or panel](#asking-copilot-to-create-a-pull-request-from-the-agents-tab-or-panel) on {% data variables.product.github %} -* The [dashboard](#asking-copilot-to-create-a-pull-request-from-the-dashboard) on {% data variables.product.github %} +* The [agents tab or panel](#asking-copilot-to-start-work-from-the-agents-tab-or-panel) on {% data variables.product.github %} +* The [dashboard](#asking-copilot-to-start-work-from-the-dashboard) on {% data variables.product.github %} * {% data variables.copilot.copilot_chat_short %} in [{% data variables.product.prodname_vscode %}](#asking-copilot-to-create-a-pull-request-from-copilot-chat-in-visual-studio-code), [JetBrains IDEs](#asking-copilot-to-create-a-pull-request-from-copilot-chat-in-jetbrains-ides), [Eclipse](#asking-copilot-to-create-a-pull-request-from-copilot-chat-in-eclipse) and [{% data variables.product.prodname_vs %} 2026](#asking-copilot-to-create-a-pull-request-from-copilot-chat-in-visual-studio-2026) * {% data variables.copilot.copilot_chat_short %} on [{% data variables.product.prodname_dotcom_the_website %}](#asking-copilot-to-create-a-pull-request-from-copilot-chat-in-githubcom) * The [{% data variables.product.prodname_cli %}](#asking-copilot-to-create-a-pull-request-from-the-github-cli) -* On [{% data variables.product.prodname_mobile %}](#asking-copilot-to-create-a-pull-request-from-github-mobile) +* On [{% data variables.product.prodname_mobile %}](#asking-copilot-to-start-work-from-github-mobile) * Your preferred IDE or agentic coding tool with [Model Context Protocol (MCP)](#asking-copilot-to-create-a-pull-request-from-the-github-mcp-server) support * The [Raycast](#asking-copilot-to-create-a-pull-request-from-raycast) launcher * The ["New repository" form](#asking-copilot-to-create-a-pull-request-from-the-new-repository-page) on {% data variables.product.github %} +* [Jira](/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-jira) +* [Slack](/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-slack) +* [Microsoft Teams](/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-teams) +* [Azure Boards](/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-azure-boards) +* [Linear](/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-linear) -{% data variables.product.prodname_copilot_short %} will start working on the task, raise a pull request, then request a review from you when it's finished working. For more information, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent). +{% data variables.product.prodname_copilot_short %} will start working on the task in the background. Some entry points open a pull request automatically. In other cases, you can prompt {% data variables.product.prodname_copilot_short %} to open a pull request, or create a pull request when {% data variables.product.prodname_copilot_short %} finishes work, from the session logs. + +For more information, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent). ## Assigning an issue to {% data variables.product.prodname_copilot_short %} You can ask {% data variables.product.prodname_copilot_short %} to start working on an issue by assigning the issue to {% data variables.product.prodname_copilot_short %}. +{% data variables.product.prodname_copilot_short %} will start working on the task, raise a pull request, then request a review from you when it's finished working + You can assign an issue to {% data variables.product.prodname_copilot_short %}: * On {% data variables.product.prodname_dotcom_the_website %} (see the [next section](#assigning-an-issue-to-copilot-on-githubcom)) @@ -438,14 +448,14 @@ gh api \ {% data reusables.copilot.cloud-agent.raycast-oauth-access-restrictions %} -## Asking {% data variables.product.prodname_copilot_short %} to create a pull request from the agents tab or panel +## Asking {% data variables.product.prodname_copilot_short %} to start work from the agents tab or panel -You can ask {% data variables.product.prodname_copilot_short %} to open a pull request from either the agents tab or the agents panel. The only difference is the entry point - once you see the "New agent task" form, the steps are the same. +You can ask start sessions from the agents tab and the agents panel. The only difference is the entry point - once you see the "New agent task" form, the steps are the same. {% data reusables.copilot.open-agents-panel-or-page %} {% data reusables.copilot.cloud-agent.new-agent-task-form-instructions %} -## Asking {% data variables.product.prodname_copilot_short %} to create a pull request from the dashboard +## Asking {% data variables.product.prodname_copilot_short %} to start work from the dashboard You can ask {% data variables.product.prodname_copilot_short %} to open a pull request from the {% data variables.product.prodname_copilot_short %} prompt box in the dashboard. The dashboard is your personalized overview of your activity on {% data variables.product.github %}, seen when you visit [https://github.com](https://github.com) while logged in. @@ -454,13 +464,15 @@ You can ask {% data variables.product.prodname_copilot_short %} to open a pull r 1. Using the dropdown menu in the prompt field, select the repository you want {% data variables.product.prodname_copilot_short %} to work in. 1. Type a prompt describing your request. - For example, `Create a pull request to implement a user friendly message for common errors.` + For example, `Implement a user friendly message for common errors.` + + If you want {% data variables.product.prodname_copilot_short %} to open a pull request, you can ask in your prompt, for example `Open a pull request to implement a user friendly message for common errors.` -1. Optionally, select a base branch for {% data variables.product.prodname_copilot_short %}'s pull request. {% data variables.product.prodname_copilot_short %} will create a new branch based on this branch, then push the changes to a pull request. +1. Optionally, select a base branch for {% data variables.product.prodname_copilot_short %}'s pull request. {% data variables.product.prodname_copilot_short %} will create a new branch based on this branch. {% data reusables.copilot.optional-select-custom-agent-dotcom %} 1. Click **{% octicon "paper-airplane" aria-label="Send now" %} Send now** or press Return. - You will be taken to the agents tab, and {% data variables.product.prodname_copilot_short %} will start a new session, which will appear in the "Recent sessions" list below the prompt box. {% data variables.product.prodname_copilot_short %} will work on the task and push changes to its pull request, then add you as a reviewer when it has finished, triggering a notification. + You will be taken to the agents tab, and {% data variables.product.prodname_copilot_short %} will start a new session, which will appear in the "Recent sessions" list below the prompt box. {% data variables.product.prodname_copilot_short %} will work on the task and push any code changes. > [!NOTE] > If you have enabled the **New Dashboard Experience** in feature preview, the new session will appear in "Agent sessions" under the prompt box in your dashboard. For more information, see [AUTOTITLE](/account-and-profile/reference/personal-dashboard#home-dashboard-view). @@ -546,19 +558,24 @@ You can ask {% data variables.product.prodname_copilot_short %} to open a pull r {% data variables.product.prodname_copilot_short %} will start a new session, which will appear in the list below the prompt box. {% data variables.product.prodname_copilot_short %} will work on the task and push changes to its pull request, then add you as a reviewer when it has finished, triggering a notification. -## Asking {% data variables.product.prodname_copilot_short %} to create a pull request from {% data variables.product.prodname_mobile %} +## Asking {% data variables.product.prodname_copilot_short %} to start work from {% data variables.product.prodname_mobile %} -1. In {% data variables.product.prodname_mobile %}, navigate to the repository where you want to create a pull request. -1. Tap the **{% octicon "copilot" aria-hidden="true" aria-label="Copilot" %}** icon in the bottom right corner of the screen. -1. Enter a prompt to ask {% data variables.product.prodname_copilot_short %} to create a pull request. +1. In {% data variables.product.prodname_mobile %}, tap the **{% octicon "copilot" aria-hidden="true" aria-label="Copilot" %}** icon in the bottom right corner of the screen, then tap **{% octicon "agent" aria-label="The Agents icon" %} New Session**. +1. Using the dropdown menu in the prompt field, select the repository you want {% data variables.product.prodname_copilot_short %} to work in. +1. Enter a prompt describing your request. + + For example: `Implement a user friendly message for common errors.`. - For example: `Create a pull request to ...`. + If you want {% data variables.product.prodname_copilot_short %} to open a pull request, you can ask in your prompt, for example `Open a pull request to implement a user friendly message for common errors.` +1. Optionally, select a base branch for {% data variables.product.prodname_copilot_short %}'s changes. {% data variables.product.prodname_copilot_short %} will create a new branch based on this branch. +{% data reusables.copilot.optional-select-custom-agent-generic %} +{% data reusables.copilot.optional-select-copilot-cloud-agent-model %} +1. Click the submit button. - {% data variables.product.prodname_copilot_short %} responds with a brief summary of the task it will perform, asking for your confirmation before it proceeds. + {% data variables.product.prodname_copilot_short %} will start a new session, work on the task and push any code changes. -1. Check that {% data variables.product.prodname_copilot_short %} has interpreted your prompt correctly, then tap **Accept** or **Dismiss**. + You can track {% data variables.product.prodname_copilot_short %}'s work and open a pull request in one click from the session logs. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions). - {% data variables.product.prodname_copilot_short %} creates a pull request and gives you a link to it. It will work on the task and push changes to the pull request, and then add you as a reviewer when it has finished, triggering a notification. ## Asking {% data variables.product.prodname_copilot_short %} to create a pull request from the {% data variables.product.prodname_cli %} diff --git a/content/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions.md index fe0c3a19c59e..d28a3ebd07d4 100644 --- a/content/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions.md @@ -36,7 +36,7 @@ To open the [agents tab](https://github.com/copilot/agents?ref_product=copilot&r Each session displays its status. Click on a session to open the session log and overview, where you can monitor the agent's progress, token usage, session count, and session length. -You can start new agent sessions from the tab. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr). +You can start new agent sessions from the tab. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions). ## Tracking agent sessions from the {% data variables.product.prodname_cli %} @@ -66,7 +66,7 @@ To see all of the available options, run `gh agent-task list --help` or `gh agen > [!NOTE] > If you are unable to see some tasks in Raycast, the organization that owns the repository may have enabled {% data variables.product.prodname_oauth_app %} access restrictions. To learn how to request approval for the "{% data variables.product.prodname_copilot %} for Raycast" {% data variables.product.prodname_oauth_app %}, see [AUTOTITLE](/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/requesting-organization-approval-for-oauth-apps). -You can also start new agent sessions from Raycast. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr#asking-copilot-to-create-a-pull-request-from-raycast). +You can also start new agent sessions from Raycast. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions#asking-copilot-to-create-a-pull-request-from-raycast). ## Tracking sessions from {% data variables.product.prodname_vscode %} @@ -78,7 +78,7 @@ For each session listed, you can see its status at a glance, or click on it to n To view the session logs, click on the pull request in the list, then click **View Session**. -You can also start new agent sessions from {% data variables.product.prodname_vscode %}. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr#asking-copilot-to-create-a-pull-request-from-copilot-chat-in-visual-studio-code). +You can also start new agent sessions from {% data variables.product.prodname_vscode %}. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions#asking-copilot-to-create-a-pull-request-from-copilot-chat-in-visual-studio-code). To directly open agent sessions in {% data variables.product.prodname_vscode_shortname %}, click the **Open in {% data variables.product.prodname_vscode_shortname %}** option on the agents tab. diff --git a/content/copilot/reference/ai-models/model-hosting.md b/content/copilot/reference/ai-models/model-hosting.md index d8a97d52de74..1494772c9832 100644 --- a/content/copilot/reference/ai-models/model-hosting.md +++ b/content/copilot/reference/ai-models/model-hosting.md @@ -49,8 +49,6 @@ These models are deployed on {% data variables.product.github %} managed Azure O ## Anthropic models -{% data reusables.copilot.opus-47-promo-period %} - Used for: * {% data variables.copilot.copilot_claude_haiku_45 %} diff --git a/content/copilot/reference/ai-models/supported-models.md b/content/copilot/reference/ai-models/supported-models.md index 5fef893e4646..60d53b7cac8b 100644 --- a/content/copilot/reference/ai-models/supported-models.md +++ b/content/copilot/reference/ai-models/supported-models.md @@ -40,7 +40,7 @@ This table lists the AI models available in {% data variables.product.prodname_c | Model name | Provider | Release status | Agent mode | Ask mode | Edit mode | |--------------------------------------------------------|-----------|----------------------------|------------|----------|-----------| | {% for model in tables.copilot.model-release-status %} | -| {{ model.name }} | {{ model.provider }} | {{ model.release_status }} | {% if model.agent_mode == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.ask_mode == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.edit_mode == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | +| {{ model.name }}{% if model.name == 'GPT-5.4 nano' %}[^gpt54nano]{% endif %} | {{ model.provider }} | {{ model.release_status }} | {% if model.agent_mode == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.ask_mode == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.edit_mode == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | | {% endfor %} | {% endrowheaders %} @@ -86,7 +86,7 @@ The following table shows which models are available in each client. | Model | {% data variables.product.prodname_dotcom_the_website %} | {% data variables.copilot.copilot_cli_short %} | {% data variables.product.prodname_vscode %} | {% data variables.product.prodname_vs %} | Eclipse | Xcode | JetBrains IDEs | | --- | --- | --- | --- | --- | --- | --- | --- | | {% for model in tables.copilot.model-supported-clients %} | -| {{ model.name }} | {% if model.dotcom == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.cli == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.vscode == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.vs == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.eclipse == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.xcode == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.jetbrains == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | +| {{ model.name }}{% if model.name == 'GPT-5.4 nano' %}[^gpt54nano]{% endif %} | {% if model.dotcom == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.cli == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.vscode == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.vs == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.eclipse == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.xcode == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.jetbrains == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | | {% endfor %} | {% endrowheaders %} @@ -113,8 +113,6 @@ The following table shows which AI models are available in each {% data variable > * {% data variables.copilot.copilot_claude_sonnet_46 %} > * {% data variables.copilot.copilot_gpt_54_mini %} -{% data reusables.copilot.opus-47-promo-period %} - {% data reusables.copilot.gpt-55-promo-period %} Each model has a premium request multiplier, based on its complexity and resource usage. If you are on a paid {% data variables.product.prodname_copilot_short %} plan, your premium request allowance is deducted according to this multiplier. @@ -141,4 +139,4 @@ Evaluation models may be added, updated, or removed without notice. Availability * To configure which models are available to you, see [AUTOTITLE](/copilot/using-github-copilot/ai-models/configuring-access-to-ai-models-in-copilot). * To learn how to change your current model, see [AUTOTITLE](/copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-chat) or [AUTOTITLE](/copilot/how-tos/use-ai-models/change-the-completion-model). * To learn more about Responsible Use and Responsible AI, see [{% data variables.product.prodname_copilot_short %} Trust Center](https://copilot.github.trust.page/) and [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features). -* To learn how {% data variables.copilot.copilot_chat_short %} serves different AI models, see [AUTOTITLE](/copilot/reference/ai-models/model-hosting). +* To learn how {% data variables.copilot.copilot_chat_short %} serves different AI models, see [AUTOTITLE](/copilot/reference/ai-models/model-hosting). \ No newline at end of file diff --git a/content/copilot/tutorials/plan-a-project.md b/content/copilot/tutorials/plan-a-project.md index 4ddc53cd7594..a0f302772c84 100644 --- a/content/copilot/tutorials/plan-a-project.md +++ b/content/copilot/tutorials/plan-a-project.md @@ -104,7 +104,7 @@ If {% data variables.product.prodname_copilot_short %} generates a sub-issue tha ## Next steps -Now that you’ve generated and refined your project issues, you can assign them to the right team members or even to {% data variables.product.prodname_copilot_short %} itself for further assistance. To learn more about how to assign {% data variables.product.prodname_copilot_short %} or contributors to issues, and how to continue planning and implementing your project with {% data variables.product.prodname_copilot_short %}’s agentic features, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr). +Now that you’ve generated and refined your project issues, you can assign them to the right team members or even to {% data variables.product.prodname_copilot_short %} itself for further assistance. To learn more about how to assign {% data variables.product.prodname_copilot_short %} or contributors to issues, and how to continue planning and implementing your project with {% data variables.product.prodname_copilot_short %}’s agentic features, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions). ## Further reading diff --git a/content/copilot/tutorials/reduce-technical-debt.md b/content/copilot/tutorials/reduce-technical-debt.md index 409a63e61f6c..0ec89422c572 100644 --- a/content/copilot/tutorials/reduce-technical-debt.md +++ b/content/copilot/tutorials/reduce-technical-debt.md @@ -166,7 +166,7 @@ Examples include: 1. Iterate in this way until the work is completed correctly. 1. Approve and merge the pull request. -For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr#assigning-an-issue-to-copilot) and [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/review-copilot-prs). +For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions#assigning-an-issue-to-copilot) and [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/review-copilot-prs). ### Safety guardrails diff --git a/content/get-started/using-github/github-mobile.md b/content/get-started/using-github/github-mobile.md index 922cf94da3f0..50729f203f26 100644 --- a/content/get-started/using-github/github-mobile.md +++ b/content/get-started/using-github/github-mobile.md @@ -38,7 +38,7 @@ The following documentation contains more information about using {% data variab * Using {% data variables.product.prodname_dotcom %} code search on {% data variables.product.prodname_mobile %}, see [AUTOTITLE](/search-github/github-code-search/using-github-code-search#using-github-code-search-on-github-mobile).{% endif %}{% ifversion fpt or ghec %} * Two-factor authentication using {% data variables.product.prodname_mobile %}, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication#configuring-two-factor-authentication-using-github-mobile) and [Authenticating using {% data variables.product.prodname_mobile %}](/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication#verifying-with-github-mobile). {% endif %}{% ifversion copilot-chat-for-mobile %} * Using {% data variables.copilot.copilot_mobile %}, see [AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github-mobile/using-github-copilot-chat-in-github-mobile).{% endif %}{% ifversion copilot-chat-for-mobile %} -* Assigning issues to {% data variables.product.prodname_copilot_short %} from {% data variables.product.prodname_mobile %}, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr).{% endif %} +* Assigning issues to {% data variables.product.prodname_copilot_short %} from {% data variables.product.prodname_mobile %}, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions).{% endif %} ## Installing {% data variables.product.prodname_mobile %} diff --git a/content/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users.md b/content/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users.md index b20b96de0b60..7d22dcafb2ee 100644 --- a/content/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users.md +++ b/content/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users.md @@ -23,7 +23,7 @@ You can assign multiple people to each issue or pull request, including: yoursel {% ifversion copilot %} -You may also be able to assign {% data variables.product.prodname_copilot_short %} to an issue, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr). +You may also be able to assign {% data variables.product.prodname_copilot_short %} to an issue, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions). {% endif %} diff --git a/content/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities.md b/content/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities.md index d8cdb06b4dd1..e438881efbef 100644 --- a/content/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities.md +++ b/content/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities.md @@ -16,6 +16,8 @@ category: An SSH certificate is a mechanism for one SSH key to sign another SSH key. If you use an SSH certificate authority (CA) to provide your organization members and outside collaborators with signed SSH certificates, you can add the CA to your enterprise account or organization to allow these organization contributors to use their certificates to access organization resources. +{% data variables.product.github %} uses OpenSSH-format SSH user certificates to authenticate Git operations over SSH by validating the certificate's signature and fields (including its validity period) against a trusted SSH certificate authority (CA) configured at the organization and/or enterprise level. + {% data reusables.organizations.ssh-ca-ghec-only %} After you add an SSH CA to your organization or enterprise account, you can use the CA to sign client SSH certificates for organization members and outside collaborators. These organization contributors can use the signed certificates to access that organization's repositories. @@ -27,7 +29,6 @@ Certificates added to your enterprise grant access to all organizations owned by Optionally, you can require that members and outside collaborators use SSH certificates to access organization resources. For more information, see [AUTOTITLE](/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities) and [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-ssh-certificate-authorities-for-your-enterprise). For example, you can build an internal system that issues a new certificate to your developers every morning. Each developer can use their daily certificate to work on your organization's repositories on {% data variables.product.github %}. At the end of the day, the certificate can automatically expire, protecting your repositories if the certificate is later compromised. - {% ifversion ghec %} Organization contributors can use their signed certificates for authentication even if you've enforced SAML single sign-on (SSO), without the need to authorize the signed certificates. @@ -88,3 +89,20 @@ You can restrict the IP addresses from which an organization member can access y ```shell ssh-keygen -s ./ca-key -V '+1d' -I KEY-IDENTITY -O extension:login@{% data variables.product.product_url %}=USERNAME -O source-address=COMMA-SEPARATED-LIST-OF-IP-ADDRESSES-OR-RANGES ./user-key.pub ``` + +## Certificate revocation and CA rotation + +{% data variables.product.github %} validates SSH certificates based on their signature, fields (including their validity period), and whether the signing CA is trusted at the organization or enterprise level. OpenSSH certificates don't use certificate revocation lists (CRLs) or the Online Certificate Status Protocol (OCSP), so there is no way to revoke an individual already-issued certificate while continuing to trust the same CA. + +To invalidate certificates before they naturally expire, remove the issuing CA from your organization or enterprise settings. Removing a CA immediately prevents {% data variables.product.github %} from accepting any SSH certificates signed by that CA. + +> [!WARNING] +> Removing a CA from your organization or enterprise settings invalidates all certificates it has signed, including certificates that have not yet expired. + +To rotate a CA with minimal disruption: + +1. Add the new CA to your enterprise or organization settings. +1. Update your certificate issuance system to sign new certificates with the new CA. +1. After all users have received new certificates from the new CA, remove the old CA. + +Issuing short-lived certificates reduces the window of risk if a certificate is compromised. For more information about managing CAs, see [AUTOTITLE](/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities) and [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-ssh-certificate-authorities-for-your-enterprise). diff --git a/content/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities.md b/content/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities.md index c6f68a5ed0de..2342bad2b67a 100644 --- a/content/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities.md +++ b/content/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities.md @@ -33,6 +33,8 @@ If you require SSH certificates for your enterprise, enterprise members should u ## Deleting an SSH certificate authority +Deleting an SSH CA from your organization immediately prevents {% data variables.product.github %} from accepting SSH certificates signed by that CA, including certificates that have not yet expired. For CA rotation guidance, see [AUTOTITLE](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities#certificate-revocation-and-ca-rotation). + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md index 171c44814379..ed344788f46f 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md @@ -52,7 +52,7 @@ To reply to an existing line or file comment, you'll need to navigate to the com When you have finished, click **Finish your review** at the top right of the page, leave a summary of your review, and click **Submit review**. -Anyone watching the pull request or repository will receive a notification of your comments. Batching your comments avoids multiple notifications being sent. {% ifversion copilot %}If you are commenting on a pull request created by {% data variables.product.prodname_copilot_short %}, batching your comments prevents {% data variables.product.prodname_copilot_short %} from starting to work on individual comments before you have completed your review. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr).{% endif %} +Anyone watching the pull request or repository will receive a notification of your comments. Batching your comments avoids multiple notifications being sent. {% ifversion copilot %}If you are commenting on a pull request created by {% data variables.product.prodname_copilot_short %}, batching your comments prevents {% data variables.product.prodname_copilot_short %} from starting to work on individual comments before you have completed your review. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions).{% endif %} ### Resolving conversations diff --git a/content/rest/copilot-spaces/collaborators.md b/content/rest/copilot-spaces/collaborators.md new file mode 100644 index 000000000000..6d3836717466 --- /dev/null +++ b/content/rest/copilot-spaces/collaborators.md @@ -0,0 +1,14 @@ +--- +title: Copilot Spaces collaborators +shortTitle: Collaborators +intro: Use the REST API to manage collaborators for Copilot Spaces. +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + fpt: '*' + ghec: '*' +autogenerated: rest +allowTitleToDifferFromFilename: true +category: + - Use Copilot and AI services +--- + + diff --git a/content/rest/copilot-spaces/copilot-spaces.md b/content/rest/copilot-spaces/copilot-spaces.md new file mode 100644 index 000000000000..f60a3e957cfe --- /dev/null +++ b/content/rest/copilot-spaces/copilot-spaces.md @@ -0,0 +1,14 @@ +--- +title: REST API endpoints for Copilot Spaces +shortTitle: Copilot Spaces +intro: Use the REST API to manage Copilot Spaces and related resources. +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + fpt: '*' + ghec: '*' +autogenerated: rest +allowTitleToDifferFromFilename: true +category: + - Use Copilot and AI services +--- + + diff --git a/content/rest/copilot-spaces/index.md b/content/rest/copilot-spaces/index.md new file mode 100644 index 000000000000..99249bd87866 --- /dev/null +++ b/content/rest/copilot-spaces/index.md @@ -0,0 +1,16 @@ +--- +title: REST API endpoints for Copilot Spaces +shortTitle: Copilot Spaces +intro: >- + Use the REST API to manage Copilot Spaces and related resources. +autogenerated: rest +allowTitleToDifferFromFilename: true +children: + - /collaborators + - /copilot-spaces + - /resources +versions: + fpt: '*' + ghec: '*' +--- + diff --git a/content/rest/copilot-spaces/resources.md b/content/rest/copilot-spaces/resources.md new file mode 100644 index 000000000000..04d1cadb3bd8 --- /dev/null +++ b/content/rest/copilot-spaces/resources.md @@ -0,0 +1,14 @@ +--- +title: REST API endpoints for Copilot Spaces +shortTitle: Copilot Spaces +intro: Use the REST API to interact with Copilot Spaces resources. +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + fpt: '*' + ghec: '*' +autogenerated: rest +allowTitleToDifferFromFilename: true +category: + - Use Copilot and AI services +--- + + diff --git a/content/rest/index.md b/content/rest/index.md index 5c3e8f7048f2..ef968e86617d 100644 --- a/content/rest/index.md +++ b/content/rest/index.md @@ -65,6 +65,7 @@ children: - /collaborators - /commits - /copilot + - /copilot-spaces - /credentials - /dependabot - /dependency-graph diff --git a/data/features/actions-github-token-pull-request-approval.yml b/data/features/actions-github-token-pull-request-approval.yml deleted file mode 100644 index 6fe3c1626b8f..000000000000 --- a/data/features/actions-github-token-pull-request-approval.yml +++ /dev/null @@ -1,7 +0,0 @@ -# Approval-required workflow runs for pull requests created or updated by -# workflows using GITHUB_TOKEN. Implementation feature flag: -# `actions_requires_approval_for_actions_bot_prs`. -versions: - fpt: '*' - ghec: '*' - # ghes: '>=3.XX' # Uncomment when this ships to GHES (currently rolling out on dotcom) diff --git a/data/features/dependabot-oidc-support.yml b/data/features/dependabot-oidc-support.yml new file mode 100644 index 000000000000..e67c5a259e92 --- /dev/null +++ b/data/features/dependabot-oidc-support.yml @@ -0,0 +1,6 @@ +# Reference: #20672 +# Configure Dependabot to use GitHub OIDC [GA] +versions: + fpt: '*' + ghec: '*' + ghes: '>3.20' diff --git a/data/reusables/copilot/available-models-per-plan.md b/data/reusables/copilot/available-models-per-plan.md index 471b00a342c5..d7e53ca0e1b3 100644 --- a/data/reusables/copilot/available-models-per-plan.md +++ b/data/reusables/copilot/available-models-per-plan.md @@ -3,7 +3,9 @@ | Available models in chat | {% data variables.copilot.copilot_free_short %} | {% data variables.copilot.copilot_student_short %} | {% data variables.copilot.copilot_pro_short %} | {% data variables.copilot.copilot_pro_plus_short %} | {% data variables.copilot.copilot_business_short %} | {% data variables.copilot.copilot_enterprise_short %} | |---------------------------------------------------------|-------------------------------------------------|----------------------------------------------|-------------------------------------------------|-----------------------------------------------------|-----------------------------------------------------|-------------------------------------------------------| | {% for model in tables.copilot.model-supported-plans %} | -| {{ model.name }} | {% if model.free == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.student == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.pro == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.pro_plus == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.business == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.enterprise == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | +| {{ model.name }}{% if model.name == 'GPT-5.4 nano' %}[^gpt54nano]{% endif %} | {% if model.free == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.student == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.pro == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.pro_plus == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.business == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | {% if model.enterprise == true %}{% octicon "check" aria-label="Included" %}{% else %}{% octicon "x" aria-label="Not included" %}{% endif %} | | {% endfor %} | {% endrowheaders %} + +[^gpt54nano]: GPT-5.4 nano is currently only available in the Codex {% data variables.product.prodname_vscode %} extension ({% data variables.copilot.copilot_pro_plus_short %} only) and is not available in {% data variables.copilot.copilot_chat_short %}. diff --git a/data/reusables/copilot/cloud-agent/new-agent-task-form-instructions.md b/data/reusables/copilot/cloud-agent/new-agent-task-form-instructions.md index 82e6f5bf653e..9acc345d768b 100644 --- a/data/reusables/copilot/cloud-agent/new-agent-task-form-instructions.md +++ b/data/reusables/copilot/cloud-agent/new-agent-task-form-instructions.md @@ -1,11 +1,15 @@ 1. Using the dropdown menu in the prompt field, select the repository you want {% data variables.product.prodname_copilot_short %} to work in. 1. Type a prompt describing your request. You can also add visual inputs like screenshots or UI mockups by pasting, dragging, or uploading an image. Files supported: image/png, image/jpeg, image/gif, image/webp. - For example, `Create a pull request to implement a user friendly message for common errors.` + For example, `Implement a user friendly message for common errors.` -1. Optionally, select a base branch for {% data variables.product.prodname_copilot_short %}'s pull request. {% data variables.product.prodname_copilot_short %} will create a new branch based on this branch, then push the changes to a pull request targeting that branch. + If you want {% data variables.product.prodname_copilot_short %} to open a pull request, you can ask in your prompt, for example `Open a pull request to implement a user friendly message for common errors.` + +1. Optionally, select a base branch for {% data variables.product.prodname_copilot_short %}'s changes. {% data variables.product.prodname_copilot_short %} will create a new branch based on this branch. {% data reusables.copilot.optional-select-custom-agent-dotcom %} {% data reusables.copilot.optional-select-copilot-cloud-agent-model %} 1. Click **{% octicon "paper-airplane" aria-label="Start task" %}** or press Enter. - {% data variables.product.prodname_copilot_short %} will start a new session, which will appear in the list below the prompt box. {% data variables.product.prodname_copilot_short %} will work on the task and push changes to its pull request, then add you as a reviewer when it has finished, triggering a notification. + {% data variables.product.prodname_copilot_short %} will start a new session, which will appear in the list below the prompt box. {% data variables.product.prodname_copilot_short %} will work on the task and push any code changes. + + You can track {% data variables.product.prodname_copilot_short %}'s work and open a pull request in one click from the session logs. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions). diff --git a/data/reusables/copilot/copilot-cli-pat-steps.md b/data/reusables/copilot/copilot-cli-pat-steps.md index 52b935d35e3a..5afe3f70dd9e 100644 --- a/data/reusables/copilot/copilot-cli-pat-steps.md +++ b/data/reusables/copilot/copilot-cli-pat-steps.md @@ -1,4 +1,10 @@ 1. Visit [{% data variables.product.pat_v2_caps_plural %}](https://github.com/settings/personal-access-tokens/new). -1. Under "Permissions," click **Add permissions** and select **{% data variables.product.prodname_copilot_short %} Requests**. +1. Under **Resource owner**, select your **personal account**. Do not select an organization. The **{% data variables.product.prodname_copilot_short %} Requests** permission is only available on user-owned {% data variables.product.pat_v2_plural %}. +1. Under **Repository access**, select the level of access appropriate for your use case: + * **Public repositories** if you only need to work with public repos. + * **All repositories** if you need access across all your current and future repos. + * **Only select repositories** f you want to restrict access to specific repos. +1. Under **Permissions**, select the **Account** tab. +1. Click **Add permissions** and select **{% data variables.product.prodname_copilot_short %} Requests**. 1. Click **Generate token**. -1. Export the token in your terminal or environment configuration. Use the `COPILOT_GITHUB_TOKEN`, `GH_TOKEN`, or `GITHUB_TOKEN` environment variable (in order of precedence). \ No newline at end of file +1. Export the token in your terminal or environment configuration. Use the `COPILOT_GITHUB_TOKEN`, `GH_TOKEN`, or `GITHUB_TOKEN` environment variable (in order of precedence). diff --git a/data/reusables/copilot/custom-agents-next-steps.md b/data/reusables/copilot/custom-agents-next-steps.md index 94a40853352c..a318720bbc57 100644 --- a/data/reusables/copilot/custom-agents-next-steps.md +++ b/data/reusables/copilot/custom-agents-next-steps.md @@ -1,3 +1,3 @@ * For a hands-on tutorial to create your first {% data variables.copilot.copilot_custom_agent_short %}, see [AUTOTITLE](/copilot/tutorials/customization-library/custom-agents/your-first-custom-agent). * For detailed configuration information, see [AUTOTITLE](/copilot/reference/custom-agents-configuration). -* For information on using cloud agents, including your {% data variables.copilot.custom_agents_short %}, to create pull requests, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr). +* For information on using cloud agents, including your {% data variables.copilot.custom_agents_short %}, to start {% data variables.product.prodname_copilot_short %} sessions, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions). diff --git a/data/reusables/copilot/custom-agents-using.md b/data/reusables/copilot/custom-agents-using.md index bb5194b0f6fd..06e4bd04c2fe 100644 --- a/data/reusables/copilot/custom-agents-using.md +++ b/data/reusables/copilot/custom-agents-using.md @@ -6,4 +6,4 @@ Once you've created a {% data variables.copilot.copilot_custom_agent_short %}, y When {% data variables.product.prodname_copilot_short %} opens pull requests, it will note which {% data variables.copilot.copilot_custom_agent_short %} was used to complete the work in the pull request description. -For more information on using {% data variables.copilot.copilot_cloud_agent %}, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr). +For more information on using {% data variables.copilot.copilot_cloud_agent %}, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions). diff --git a/data/reusables/copilot/optional-select-custom-agent-dotcom.md b/data/reusables/copilot/optional-select-custom-agent-dotcom.md index 485199a6bb2d..7577bed75de6 100644 --- a/data/reusables/copilot/optional-select-custom-agent-dotcom.md +++ b/data/reusables/copilot/optional-select-custom-agent-dotcom.md @@ -1,2 +1,2 @@ 1. Optionally, you can click {% octicon "copilot" aria-hidden="true" aria-label="copilot" %} to open the agent dropdown menu, if you want to assign an agent or a {% data variables.copilot.copilot_custom_agent_short %} with specialized behavior and tools. You can select an existing {% data variables.copilot.copilot_custom_agent_short %} from your repository, organization, or enterprise. You can also click **{% octicon "plus" aria-label="Plus button" %} Create an agent** to create a new {% data variables.copilot.agent_profile %} in your selected repository and branch. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents). - > [!NOTE] Third-party coding agents are available in the {% data variables.copilot.copilot_pro_plus %} and {% data variables.copilot.copilot_enterprise_short %} plans. + > [!NOTE] {% data reusables.gated-features.third-party-agents %} diff --git a/data/reusables/copilot/opus-47-promo-period.md b/data/reusables/copilot/opus-47-promo-period.md index e078202a37b1..e69de29bb2d1 100644 --- a/data/reusables/copilot/opus-47-promo-period.md +++ b/data/reusables/copilot/opus-47-promo-period.md @@ -1 +0,0 @@ -> [!IMPORTANT] {% data variables.copilot.copilot_claude_opus_47 %} is available at a promotional multiplier of 7.5x until April 30, 2026. diff --git a/data/reusables/copilot/plans/organization-plans-paused.md b/data/reusables/copilot/plans/organization-plans-paused.md new file mode 100644 index 000000000000..b9481e46be0c --- /dev/null +++ b/data/reusables/copilot/plans/organization-plans-paused.md @@ -0,0 +1 @@ +**Starting April 22, 2026**, new self-serve sign-ups for {% data variables.copilot.copilot_business_short %} for organizations on {% data variables.product.prodname_free_team %} and {% data variables.product.prodname_team %} plans are temporarily paused. \ No newline at end of file diff --git a/data/reusables/copilot/quickstart-signup.md b/data/reusables/copilot/quickstart-signup.md index c3cad1fe33ca..4885a4d0ef2e 100644 --- a/data/reusables/copilot/quickstart-signup.md +++ b/data/reusables/copilot/quickstart-signup.md @@ -10,7 +10,8 @@ To use {% data variables.product.prodname_copilot_short %}, you’ll need a pers * Upgrade to {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} to unlock more features, models, and request limits. >[!IMPORTANT] - > {% data reusables.copilot.plans.individual-plans-paused %} + > * {% data reusables.copilot.plans.individual-plans-paused %} + > * {% data reusables.copilot.plans.organization-plans-paused %} For more information about the different plans for {% data variables.product.prodname_copilot %}, see [AUTOTITLE](/copilot/about-github-copilot/subscription-plans-for-github-copilot). diff --git a/data/reusables/data-residency/when-you-adopt-data-residency.md b/data/reusables/data-residency/when-you-adopt-data-residency.md index 640f8144ed85..731656a78252 100644 --- a/data/reusables/data-residency/when-you-adopt-data-residency.md +++ b/data/reusables/data-residency/when-you-adopt-data-residency.md @@ -4,7 +4,7 @@ Data residency makes it easy to separate open source and enterprise work, and he The available regions are: -* EU (includes EFTA countries, Norway and Switzerland, as of May 1, 2026) +* EU (includes Azure regions in EFTA countries, currently Norway and Switzerland) * Australia * US * Japan diff --git a/data/reusables/files/commit-author-email-options.md b/data/reusables/files/commit-author-email-options.md index 456e71604061..2e581aa2cc1d 100644 --- a/data/reusables/files/commit-author-email-options.md +++ b/data/reusables/files/commit-author-email-options.md @@ -1,3 +1,3 @@ {% ifversion fpt or ghec %} -If you haven't enabled email address privacy, you can choose which verified email address to author changes with when you edit, delete, or create files or merge a pull request in the user interface. If you enabled email address privacy, then the commit author email address cannot be changed and will be a no-reply by default. For more information about the exact form the no-reply email address can take, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address). +If you haven't enabled email address privacy, you can choose which verified email address to author changes with when you edit, delete, or create files or merge a pull request in the user interface. If you enabled email address privacy, then the commit author email address cannot be changed and will be a no-reply by default. For more information about the exact form the no-reply email address can take, see [AUTOTITLE](/account-and-profile/reference/email-addresses-reference#your-noreply-email-address). {% endif %} diff --git a/data/tables/copilot/annual-subscriber-model-multipliers.yml b/data/tables/copilot/annual-subscriber-model-multipliers.yml index 72757cd73a13..d498d032966c 100644 --- a/data/tables/copilot/annual-subscriber-model-multipliers.yml +++ b/data/tables/copilot/annual-subscriber-model-multipliers.yml @@ -19,7 +19,7 @@ new_multiplier: '27' - model: 'Claude Opus 4.7' - current_multiplier: '7.5' + current_multiplier: '15' new_multiplier: '27' - model: 'Claude Sonnet 4' diff --git a/data/tables/copilot/model-multipliers.yml b/data/tables/copilot/model-multipliers.yml index 1c3e6b0ce757..e5e464c4da06 100644 --- a/data/tables/copilot/model-multipliers.yml +++ b/data/tables/copilot/model-multipliers.yml @@ -26,7 +26,7 @@ multiplier_free: Not applicable - name: Claude Opus 4.7 - multiplier_paid: 7.5 + multiplier_paid: 15 multiplier_free: Not applicable - name: Claude Sonnet 4 diff --git a/data/tables/copilot/model-release-status.yml b/data/tables/copilot/model-release-status.yml index 00dc55a9d2a9..f79139d4a6f9 100644 --- a/data/tables/copilot/model-release-status.yml +++ b/data/tables/copilot/model-release-status.yml @@ -70,9 +70,9 @@ - name: 'GPT-5.4 nano' provider: 'OpenAI' release_status: 'GA' - agent_mode: true - ask_mode: true - edit_mode: true + agent_mode: false + ask_mode: false + edit_mode: false - name: 'GPT-5.5' provider: 'OpenAI' diff --git a/data/tables/copilot/model-supported-plans.yml b/data/tables/copilot/model-supported-plans.yml index de685c02f118..692467aab8c3 100644 --- a/data/tables/copilot/model-supported-plans.yml +++ b/data/tables/copilot/model-supported-plans.yml @@ -159,11 +159,11 @@ - name: GPT-5.4 nano free: false - student: true - pro: true + student: false + pro: false pro_plus: true - business: true - enterprise: true + business: false + enterprise: false - name: GPT-5.5 free: false diff --git a/src/audit-logs/data/fpt/organization.json b/src/audit-logs/data/fpt/organization.json index e98cc3533434..4a593f3780f4 100644 --- a/src/audit-logs/data/fpt/organization.json +++ b/src/audit-logs/data/fpt/organization.json @@ -8142,6 +8142,70 @@ "actor_is_bot" ] }, + { + "action": "org.code_scanning_scan_inactive_repos_disabled", + "description": "Scanning inactive repositories was disabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, + { + "action": "org.code_scanning_scan_inactive_repos_enabled", + "description": "Scanning inactive repositories was enabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, { "action": "org.code_security_metered_usage_lock", "description": "Enablement for Code Security features on new repositories has been locked for this organization.", diff --git a/src/audit-logs/data/ghec/enterprise.json b/src/audit-logs/data/ghec/enterprise.json index 0ac3dd6ab526..c8915fc7bb01 100644 --- a/src/audit-logs/data/ghec/enterprise.json +++ b/src/audit-logs/data/ghec/enterprise.json @@ -14069,6 +14069,70 @@ "actor_is_bot" ] }, + { + "action": "org.code_scanning_scan_inactive_repos_disabled", + "description": "Scanning inactive repositories was disabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, + { + "action": "org.code_scanning_scan_inactive_repos_enabled", + "description": "Scanning inactive repositories was enabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, { "action": "org.codeql_disabled", "description": "Code scanning using the default setup was disabled for an organization.", diff --git a/src/audit-logs/data/ghec/organization.json b/src/audit-logs/data/ghec/organization.json index e98cc3533434..4a593f3780f4 100644 --- a/src/audit-logs/data/ghec/organization.json +++ b/src/audit-logs/data/ghec/organization.json @@ -8142,6 +8142,70 @@ "actor_is_bot" ] }, + { + "action": "org.code_scanning_scan_inactive_repos_disabled", + "description": "Scanning inactive repositories was disabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, + { + "action": "org.code_scanning_scan_inactive_repos_enabled", + "description": "Scanning inactive repositories was enabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, { "action": "org.code_security_metered_usage_lock", "description": "Enablement for Code Security features on new repositories has been locked for this organization.", diff --git a/src/audit-logs/data/ghes-3.14/enterprise.json b/src/audit-logs/data/ghes-3.14/enterprise.json index b49112ba6e3d..ce1e81f99085 100644 --- a/src/audit-logs/data/ghes-3.14/enterprise.json +++ b/src/audit-logs/data/ghes-3.14/enterprise.json @@ -9376,6 +9376,70 @@ "actor_is_bot" ] }, + { + "action": "org.code_scanning_scan_inactive_repos_disabled", + "description": "Scanning inactive repositories was disabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, + { + "action": "org.code_scanning_scan_inactive_repos_enabled", + "description": "Scanning inactive repositories was enabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, { "action": "org.codeql_disabled", "description": "Code scanning using the default setup was disabled for an organization.", diff --git a/src/audit-logs/data/ghes-3.14/organization.json b/src/audit-logs/data/ghes-3.14/organization.json index e9ef1d885c72..75b575cceb28 100644 --- a/src/audit-logs/data/ghes-3.14/organization.json +++ b/src/audit-logs/data/ghes-3.14/organization.json @@ -6827,6 +6827,70 @@ "actor_is_bot" ] }, + { + "action": "org.code_scanning_scan_inactive_repos_disabled", + "description": "Scanning inactive repositories was disabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, + { + "action": "org.code_scanning_scan_inactive_repos_enabled", + "description": "Scanning inactive repositories was enabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, { "action": "org.codeql_disabled", "description": "Code scanning using the default setup was disabled for an organization.", diff --git a/src/audit-logs/data/ghes-3.15/enterprise.json b/src/audit-logs/data/ghes-3.15/enterprise.json index eb46d115068d..20cbf30da699 100644 --- a/src/audit-logs/data/ghes-3.15/enterprise.json +++ b/src/audit-logs/data/ghes-3.15/enterprise.json @@ -9376,6 +9376,70 @@ "actor_is_bot" ] }, + { + "action": "org.code_scanning_scan_inactive_repos_disabled", + "description": "Scanning inactive repositories was disabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, + { + "action": "org.code_scanning_scan_inactive_repos_enabled", + "description": "Scanning inactive repositories was enabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, { "action": "org.codeql_disabled", "description": "Code scanning using the default setup was disabled for an organization.", diff --git a/src/audit-logs/data/ghes-3.15/organization.json b/src/audit-logs/data/ghes-3.15/organization.json index 5d7cffbfe8ea..f13e64c4929f 100644 --- a/src/audit-logs/data/ghes-3.15/organization.json +++ b/src/audit-logs/data/ghes-3.15/organization.json @@ -6862,6 +6862,70 @@ "actor_is_bot" ] }, + { + "action": "org.code_scanning_scan_inactive_repos_disabled", + "description": "Scanning inactive repositories was disabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, + { + "action": "org.code_scanning_scan_inactive_repos_enabled", + "description": "Scanning inactive repositories was enabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, { "action": "org.codeql_disabled", "description": "Code scanning using the default setup was disabled for an organization.", diff --git a/src/audit-logs/data/ghes-3.16/enterprise.json b/src/audit-logs/data/ghes-3.16/enterprise.json index cac82a3809a8..c245204f8266 100644 --- a/src/audit-logs/data/ghes-3.16/enterprise.json +++ b/src/audit-logs/data/ghes-3.16/enterprise.json @@ -9820,6 +9820,70 @@ "actor_is_bot" ] }, + { + "action": "org.code_scanning_scan_inactive_repos_disabled", + "description": "Scanning inactive repositories was disabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, + { + "action": "org.code_scanning_scan_inactive_repos_enabled", + "description": "Scanning inactive repositories was enabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, { "action": "org.codeql_disabled", "description": "Code scanning using the default setup was disabled for an organization.", diff --git a/src/audit-logs/data/ghes-3.16/organization.json b/src/audit-logs/data/ghes-3.16/organization.json index a2f663469d77..d15c243f0076 100644 --- a/src/audit-logs/data/ghes-3.16/organization.json +++ b/src/audit-logs/data/ghes-3.16/organization.json @@ -7127,6 +7127,70 @@ "actor_is_bot" ] }, + { + "action": "org.code_scanning_scan_inactive_repos_disabled", + "description": "Scanning inactive repositories was disabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, + { + "action": "org.code_scanning_scan_inactive_repos_enabled", + "description": "Scanning inactive repositories was enabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, { "action": "org.codeql_disabled", "description": "Code scanning using the default setup was disabled for an organization.", diff --git a/src/audit-logs/data/ghes-3.17/enterprise.json b/src/audit-logs/data/ghes-3.17/enterprise.json index 9c9cad6de2df..18b1b8b6d895 100644 --- a/src/audit-logs/data/ghes-3.17/enterprise.json +++ b/src/audit-logs/data/ghes-3.17/enterprise.json @@ -10196,6 +10196,70 @@ "actor_is_bot" ] }, + { + "action": "org.code_scanning_scan_inactive_repos_disabled", + "description": "Scanning inactive repositories was disabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, + { + "action": "org.code_scanning_scan_inactive_repos_enabled", + "description": "Scanning inactive repositories was enabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, { "action": "org.codeql_disabled", "description": "Code scanning using the default setup was disabled for an organization.", diff --git a/src/audit-logs/data/ghes-3.17/organization.json b/src/audit-logs/data/ghes-3.17/organization.json index d81e69fc44db..bfe4d0f647c9 100644 --- a/src/audit-logs/data/ghes-3.17/organization.json +++ b/src/audit-logs/data/ghes-3.17/organization.json @@ -7429,6 +7429,70 @@ "actor_is_bot" ] }, + { + "action": "org.code_scanning_scan_inactive_repos_disabled", + "description": "Scanning inactive repositories was disabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, + { + "action": "org.code_scanning_scan_inactive_repos_enabled", + "description": "Scanning inactive repositories was enabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, { "action": "org.codeql_disabled", "description": "Code scanning using the default setup was disabled for an organization.", diff --git a/src/audit-logs/data/ghes-3.18/enterprise.json b/src/audit-logs/data/ghes-3.18/enterprise.json index 14e11a4fd972..0a8282e84a0c 100644 --- a/src/audit-logs/data/ghes-3.18/enterprise.json +++ b/src/audit-logs/data/ghes-3.18/enterprise.json @@ -10266,6 +10266,70 @@ "actor_is_bot" ] }, + { + "action": "org.code_scanning_scan_inactive_repos_disabled", + "description": "Scanning inactive repositories was disabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, + { + "action": "org.code_scanning_scan_inactive_repos_enabled", + "description": "Scanning inactive repositories was enabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, { "action": "org.codeql_disabled", "description": "Code scanning using the default setup was disabled for an organization.", diff --git a/src/audit-logs/data/ghes-3.18/organization.json b/src/audit-logs/data/ghes-3.18/organization.json index 9d991afc43fc..b4e0f4bf20f4 100644 --- a/src/audit-logs/data/ghes-3.18/organization.json +++ b/src/audit-logs/data/ghes-3.18/organization.json @@ -7676,6 +7676,70 @@ "actor_is_bot" ] }, + { + "action": "org.code_scanning_scan_inactive_repos_disabled", + "description": "Scanning inactive repositories was disabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, + { + "action": "org.code_scanning_scan_inactive_repos_enabled", + "description": "Scanning inactive repositories was enabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, { "action": "org.codeql_disabled", "description": "Code scanning using the default setup was disabled for an organization.", diff --git a/src/audit-logs/data/ghes-3.19/enterprise.json b/src/audit-logs/data/ghes-3.19/enterprise.json index d01981209d3a..5432bc7b9a50 100644 --- a/src/audit-logs/data/ghes-3.19/enterprise.json +++ b/src/audit-logs/data/ghes-3.19/enterprise.json @@ -10900,6 +10900,70 @@ "actor_is_bot" ] }, + { + "action": "org.code_scanning_scan_inactive_repos_disabled", + "description": "Scanning inactive repositories was disabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, + { + "action": "org.code_scanning_scan_inactive_repos_enabled", + "description": "Scanning inactive repositories was enabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, { "action": "org.codeql_disabled", "description": "Code scanning using the default setup was disabled for an organization.", diff --git a/src/audit-logs/data/ghes-3.19/organization.json b/src/audit-logs/data/ghes-3.19/organization.json index bca9a64e7c77..94e6c821a22c 100644 --- a/src/audit-logs/data/ghes-3.19/organization.json +++ b/src/audit-logs/data/ghes-3.19/organization.json @@ -8028,6 +8028,70 @@ "actor_is_bot" ] }, + { + "action": "org.code_scanning_scan_inactive_repos_disabled", + "description": "Scanning inactive repositories was disabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, + { + "action": "org.code_scanning_scan_inactive_repos_enabled", + "description": "Scanning inactive repositories was enabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, { "action": "org.code_security_metered_usage_lock", "description": "Enablement for Code Security features on new repositories has been locked for this organization.", diff --git a/src/audit-logs/data/ghes-3.20/enterprise.json b/src/audit-logs/data/ghes-3.20/enterprise.json index 526dc4450370..509aaaef496f 100644 --- a/src/audit-logs/data/ghes-3.20/enterprise.json +++ b/src/audit-logs/data/ghes-3.20/enterprise.json @@ -10933,6 +10933,70 @@ "actor_is_bot" ] }, + { + "action": "org.code_scanning_scan_inactive_repos_disabled", + "description": "Scanning inactive repositories was disabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, + { + "action": "org.code_scanning_scan_inactive_repos_enabled", + "description": "Scanning inactive repositories was enabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, { "action": "org.codeql_disabled", "description": "Code scanning using the default setup was disabled for an organization.", diff --git a/src/audit-logs/data/ghes-3.20/organization.json b/src/audit-logs/data/ghes-3.20/organization.json index 9f97bf91b246..cefd575d70f4 100644 --- a/src/audit-logs/data/ghes-3.20/organization.json +++ b/src/audit-logs/data/ghes-3.20/organization.json @@ -7965,6 +7965,70 @@ "actor_is_bot" ] }, + { + "action": "org.code_scanning_scan_inactive_repos_disabled", + "description": "Scanning inactive repositories was disabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, + { + "action": "org.code_scanning_scan_inactive_repos_enabled", + "description": "Scanning inactive repositories was enabled for an organization.", + "docs_reference_links": "N/A", + "fields": [ + "@timestamp", + "_document_id", + "action", + "actor", + "actor_id", + "business", + "business_id", + "hashed_token", + "org", + "org_id", + "programmatic_access_type", + "repo", + "repo_id", + "repository", + "repository_id", + "request_access_security_header", + "request_id", + "token_id", + "token_scopes", + "user", + "user_id", + "user_agent", + "created_at", + "operation_type", + "actor_is_bot" + ] + }, { "action": "org.code_security_metered_usage_lock", "description": "Enablement for Code Security features on new repositories has been locked for this organization.", diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index a2cb817275d3..efd6277f6c81 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -9,5 +9,5 @@ "git": "Note: Git events have special access requirements and retention policies that differ from other audit log events. For GitHub Enterprise Cloud, access Git events via the REST API only with 7-day retention. For GitHub Enterprise Server, Git events must be enabled in audit log configuration and are not included in search results.", "sso_redirect": "Note: Automatically redirecting users to sign in is currently in beta for Enterprise Managed Users and subject to change." }, - "sha": "36e1b1ff7db94c01a1e31998e0a8abefddb327bc" + "sha": "9df25a1e15e65e600ce78a0a9445486054c6ddc1" } \ No newline at end of file diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json index 091662210571..0ac456e84042 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json @@ -1082,7 +1082,7 @@ "permissions": [ { "category": "copilot", - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", @@ -1091,7 +1091,7 @@ }, { "category": "copilot", - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", @@ -1100,7 +1100,7 @@ }, { "category": "copilot", - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", @@ -1109,7 +1109,7 @@ }, { "category": "copilot", - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", @@ -1118,7 +1118,7 @@ }, { "category": "copilot", - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", @@ -1127,7 +1127,7 @@ }, { "category": "copilot", - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", @@ -1272,6 +1272,42 @@ "title": "GitHub Copilot Business", "displayTitle": "Organization permissions for \"GitHub Copilot Business\"", "permissions": [ + { + "category": "copilot-spaces", + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "additional-permissions": false, + "access": "read" + }, + { + "category": "copilot-spaces", + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "additional-permissions": false, + "access": "write" + }, + { + "category": "copilot-spaces", + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "copilot-spaces", + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "additional-permissions": false, + "access": "write" + }, { "category": "copilot", "slug": "get-copilot-seat-information-and-settings-for-an-organization", diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json index 1484fecf9c7d..5529b670de5f 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json @@ -2169,37 +2169,37 @@ "requestPath": "/orgs/{org}/copilot/billing/selected_users" }, { - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" }, { - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" @@ -2259,6 +2259,92 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], + "copilot-spaces": [ + { + "slug": "list-organization-copilot-spaces", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "create-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "get-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "set-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "delete-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "list-resources-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "create-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "get-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "set-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "delete-a-resource-from-an-organization-copilot-space", + "subcategory": "resources", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + } + ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-enterprise", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json index bf0df4d3362c..9fb0e35ffdce 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json @@ -1559,7 +1559,7 @@ "permissions": [ { "category": "copilot", - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", @@ -1570,7 +1570,7 @@ }, { "category": "copilot", - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", @@ -1581,7 +1581,7 @@ }, { "category": "copilot", - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", @@ -1592,7 +1592,7 @@ }, { "category": "copilot", - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", @@ -1603,7 +1603,7 @@ }, { "category": "copilot", - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", @@ -1614,7 +1614,7 @@ }, { "category": "copilot", - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", @@ -1785,6 +1785,50 @@ "title": "GitHub Copilot Business", "displayTitle": "Organization permissions for \"GitHub Copilot Business\"", "permissions": [ + { + "category": "copilot-spaces", + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "copilot-spaces", + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "copilot-spaces", + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "copilot-spaces", + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "copilot", "slug": "get-copilot-seat-information-and-settings-for-an-organization", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json index ae4a83e934b0..28a0b3c57ca6 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json @@ -2181,37 +2181,37 @@ "requestPath": "/orgs/{org}/copilot/billing/selected_users" }, { - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" }, { - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" @@ -2271,6 +2271,92 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], + "copilot-spaces": [ + { + "slug": "list-organization-copilot-spaces", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "create-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "get-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "set-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "delete-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "list-resources-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "create-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "get-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "set-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "delete-a-resource-from-an-organization-copilot-space", + "subcategory": "resources", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + } + ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-enterprise", diff --git a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json index 07ae50a3a345..b489d58212b5 100644 --- a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json @@ -2447,37 +2447,37 @@ "requestPath": "/orgs/{org}/copilot/billing/selected_users" }, { - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" }, { - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" @@ -2537,6 +2537,92 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], + "copilot-spaces": [ + { + "slug": "list-organization-copilot-spaces", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "create-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "get-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "set-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "delete-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "list-resources-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "create-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "get-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "set-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "delete-a-resource-from-an-organization-copilot-space", + "subcategory": "resources", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + } + ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-enterprise", diff --git a/src/github-apps/data/fpt-2026-03-10/fine-grained-pat-permissions.json b/src/github-apps/data/fpt-2026-03-10/fine-grained-pat-permissions.json index 091662210571..0ac456e84042 100644 --- a/src/github-apps/data/fpt-2026-03-10/fine-grained-pat-permissions.json +++ b/src/github-apps/data/fpt-2026-03-10/fine-grained-pat-permissions.json @@ -1082,7 +1082,7 @@ "permissions": [ { "category": "copilot", - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", @@ -1091,7 +1091,7 @@ }, { "category": "copilot", - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", @@ -1100,7 +1100,7 @@ }, { "category": "copilot", - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", @@ -1109,7 +1109,7 @@ }, { "category": "copilot", - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", @@ -1118,7 +1118,7 @@ }, { "category": "copilot", - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", @@ -1127,7 +1127,7 @@ }, { "category": "copilot", - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", @@ -1272,6 +1272,42 @@ "title": "GitHub Copilot Business", "displayTitle": "Organization permissions for \"GitHub Copilot Business\"", "permissions": [ + { + "category": "copilot-spaces", + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "additional-permissions": false, + "access": "read" + }, + { + "category": "copilot-spaces", + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "additional-permissions": false, + "access": "write" + }, + { + "category": "copilot-spaces", + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "copilot-spaces", + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "additional-permissions": false, + "access": "write" + }, { "category": "copilot", "slug": "get-copilot-seat-information-and-settings-for-an-organization", diff --git a/src/github-apps/data/fpt-2026-03-10/fine-grained-pat.json b/src/github-apps/data/fpt-2026-03-10/fine-grained-pat.json index 1484fecf9c7d..5529b670de5f 100644 --- a/src/github-apps/data/fpt-2026-03-10/fine-grained-pat.json +++ b/src/github-apps/data/fpt-2026-03-10/fine-grained-pat.json @@ -2169,37 +2169,37 @@ "requestPath": "/orgs/{org}/copilot/billing/selected_users" }, { - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" }, { - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" @@ -2259,6 +2259,92 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], + "copilot-spaces": [ + { + "slug": "list-organization-copilot-spaces", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "create-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "get-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "set-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "delete-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "list-resources-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "create-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "get-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "set-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "delete-a-resource-from-an-organization-copilot-space", + "subcategory": "resources", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + } + ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-enterprise", diff --git a/src/github-apps/data/fpt-2026-03-10/server-to-server-permissions.json b/src/github-apps/data/fpt-2026-03-10/server-to-server-permissions.json index bf0df4d3362c..9fb0e35ffdce 100644 --- a/src/github-apps/data/fpt-2026-03-10/server-to-server-permissions.json +++ b/src/github-apps/data/fpt-2026-03-10/server-to-server-permissions.json @@ -1559,7 +1559,7 @@ "permissions": [ { "category": "copilot", - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", @@ -1570,7 +1570,7 @@ }, { "category": "copilot", - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", @@ -1581,7 +1581,7 @@ }, { "category": "copilot", - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", @@ -1592,7 +1592,7 @@ }, { "category": "copilot", - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", @@ -1603,7 +1603,7 @@ }, { "category": "copilot", - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", @@ -1614,7 +1614,7 @@ }, { "category": "copilot", - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", @@ -1785,6 +1785,50 @@ "title": "GitHub Copilot Business", "displayTitle": "Organization permissions for \"GitHub Copilot Business\"", "permissions": [ + { + "category": "copilot-spaces", + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "copilot-spaces", + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "copilot-spaces", + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "copilot-spaces", + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "copilot", "slug": "get-copilot-seat-information-and-settings-for-an-organization", diff --git a/src/github-apps/data/fpt-2026-03-10/server-to-server-rest.json b/src/github-apps/data/fpt-2026-03-10/server-to-server-rest.json index ae4a83e934b0..28a0b3c57ca6 100644 --- a/src/github-apps/data/fpt-2026-03-10/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2026-03-10/server-to-server-rest.json @@ -2181,37 +2181,37 @@ "requestPath": "/orgs/{org}/copilot/billing/selected_users" }, { - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" }, { - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" @@ -2271,6 +2271,92 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], + "copilot-spaces": [ + { + "slug": "list-organization-copilot-spaces", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "create-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "get-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "set-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "delete-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "list-resources-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "create-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "get-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "set-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "delete-a-resource-from-an-organization-copilot-space", + "subcategory": "resources", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + } + ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-enterprise", diff --git a/src/github-apps/data/fpt-2026-03-10/user-to-server-rest.json b/src/github-apps/data/fpt-2026-03-10/user-to-server-rest.json index 07ae50a3a345..b489d58212b5 100644 --- a/src/github-apps/data/fpt-2026-03-10/user-to-server-rest.json +++ b/src/github-apps/data/fpt-2026-03-10/user-to-server-rest.json @@ -2447,37 +2447,37 @@ "requestPath": "/orgs/{org}/copilot/billing/selected_users" }, { - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" }, { - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" @@ -2537,6 +2537,92 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], + "copilot-spaces": [ + { + "slug": "list-organization-copilot-spaces", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "create-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "get-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "set-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "delete-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "list-resources-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "create-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "get-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "set-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "delete-a-resource-from-an-organization-copilot-space", + "subcategory": "resources", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + } + ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-enterprise", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json index 3d34a1d9433b..4229083596da 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json @@ -1118,7 +1118,7 @@ "permissions": [ { "category": "copilot", - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", @@ -1127,7 +1127,7 @@ }, { "category": "copilot", - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", @@ -1136,7 +1136,7 @@ }, { "category": "copilot", - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", @@ -1145,7 +1145,7 @@ }, { "category": "copilot", - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", @@ -1154,7 +1154,7 @@ }, { "category": "copilot", - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", @@ -1163,7 +1163,7 @@ }, { "category": "copilot", - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", @@ -1482,6 +1482,42 @@ "title": "GitHub Copilot Business", "displayTitle": "Organization permissions for \"GitHub Copilot Business\"", "permissions": [ + { + "category": "copilot-spaces", + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "additional-permissions": false, + "access": "read" + }, + { + "category": "copilot-spaces", + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "additional-permissions": false, + "access": "write" + }, + { + "category": "copilot-spaces", + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "copilot-spaces", + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "additional-permissions": false, + "access": "write" + }, { "category": "copilot", "slug": "get-copilot-seat-information-and-settings-for-an-organization", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json index f6533cbb7832..1442649db075 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json @@ -2177,37 +2177,37 @@ "requestPath": "/orgs/{org}/copilot/billing/selected_users" }, { - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" }, { - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" @@ -2267,6 +2267,92 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], + "copilot-spaces": [ + { + "slug": "list-organization-copilot-spaces", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "create-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "get-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "set-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "delete-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "list-resources-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "create-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "get-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "set-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "delete-a-resource-from-an-organization-copilot-space", + "subcategory": "resources", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + } + ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-enterprise", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json index 63a38552a670..8977d37dcfd9 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json @@ -2261,7 +2261,7 @@ "permissions": [ { "category": "copilot", - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", @@ -2272,7 +2272,7 @@ }, { "category": "copilot", - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", @@ -2283,7 +2283,7 @@ }, { "category": "copilot", - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", @@ -2294,7 +2294,7 @@ }, { "category": "copilot", - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", @@ -2305,7 +2305,7 @@ }, { "category": "copilot", - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", @@ -2316,7 +2316,7 @@ }, { "category": "copilot", - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", @@ -2697,6 +2697,50 @@ "title": "GitHub Copilot Business", "displayTitle": "Organization permissions for \"GitHub Copilot Business\"", "permissions": [ + { + "category": "copilot-spaces", + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "copilot-spaces", + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "copilot-spaces", + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "copilot-spaces", + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "copilot", "slug": "get-copilot-seat-information-and-settings-for-an-organization", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index 509fb1c9ddaf..6341e24319e3 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -2255,37 +2255,37 @@ "requestPath": "/orgs/{org}/copilot/billing/selected_users" }, { - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" }, { - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" @@ -2345,6 +2345,92 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], + "copilot-spaces": [ + { + "slug": "list-organization-copilot-spaces", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "create-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "get-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "set-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "delete-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "list-resources-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "create-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "get-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "set-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "delete-a-resource-from-an-organization-copilot-space", + "subcategory": "resources", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + } + ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-enterprise", diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json index 3db3b14ea98d..793f8b615901 100644 --- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json @@ -2503,37 +2503,37 @@ "requestPath": "/orgs/{org}/copilot/billing/selected_users" }, { - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" }, { - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" @@ -2593,6 +2593,92 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], + "copilot-spaces": [ + { + "slug": "list-organization-copilot-spaces", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "create-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "get-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "set-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "delete-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "list-resources-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "create-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "get-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "set-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "delete-a-resource-from-an-organization-copilot-space", + "subcategory": "resources", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + } + ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-enterprise", diff --git a/src/github-apps/data/ghec-2026-03-10/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2026-03-10/fine-grained-pat-permissions.json index 3d34a1d9433b..4229083596da 100644 --- a/src/github-apps/data/ghec-2026-03-10/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghec-2026-03-10/fine-grained-pat-permissions.json @@ -1118,7 +1118,7 @@ "permissions": [ { "category": "copilot", - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", @@ -1127,7 +1127,7 @@ }, { "category": "copilot", - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", @@ -1136,7 +1136,7 @@ }, { "category": "copilot", - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", @@ -1145,7 +1145,7 @@ }, { "category": "copilot", - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", @@ -1154,7 +1154,7 @@ }, { "category": "copilot", - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", @@ -1163,7 +1163,7 @@ }, { "category": "copilot", - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", @@ -1482,6 +1482,42 @@ "title": "GitHub Copilot Business", "displayTitle": "Organization permissions for \"GitHub Copilot Business\"", "permissions": [ + { + "category": "copilot-spaces", + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "additional-permissions": false, + "access": "read" + }, + { + "category": "copilot-spaces", + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "additional-permissions": false, + "access": "write" + }, + { + "category": "copilot-spaces", + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "copilot-spaces", + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "additional-permissions": false, + "access": "write" + }, { "category": "copilot", "slug": "get-copilot-seat-information-and-settings-for-an-organization", diff --git a/src/github-apps/data/ghec-2026-03-10/fine-grained-pat.json b/src/github-apps/data/ghec-2026-03-10/fine-grained-pat.json index f6533cbb7832..1442649db075 100644 --- a/src/github-apps/data/ghec-2026-03-10/fine-grained-pat.json +++ b/src/github-apps/data/ghec-2026-03-10/fine-grained-pat.json @@ -2177,37 +2177,37 @@ "requestPath": "/orgs/{org}/copilot/billing/selected_users" }, { - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" }, { - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" @@ -2267,6 +2267,92 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], + "copilot-spaces": [ + { + "slug": "list-organization-copilot-spaces", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "create-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "get-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "set-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "delete-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "list-resources-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "create-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "get-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "set-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "delete-a-resource-from-an-organization-copilot-space", + "subcategory": "resources", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + } + ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-enterprise", diff --git a/src/github-apps/data/ghec-2026-03-10/server-to-server-permissions.json b/src/github-apps/data/ghec-2026-03-10/server-to-server-permissions.json index 63a38552a670..8977d37dcfd9 100644 --- a/src/github-apps/data/ghec-2026-03-10/server-to-server-permissions.json +++ b/src/github-apps/data/ghec-2026-03-10/server-to-server-permissions.json @@ -2261,7 +2261,7 @@ "permissions": [ { "category": "copilot", - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", @@ -2272,7 +2272,7 @@ }, { "category": "copilot", - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", @@ -2283,7 +2283,7 @@ }, { "category": "copilot", - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", @@ -2294,7 +2294,7 @@ }, { "category": "copilot", - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", @@ -2305,7 +2305,7 @@ }, { "category": "copilot", - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", @@ -2316,7 +2316,7 @@ }, { "category": "copilot", - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", @@ -2697,6 +2697,50 @@ "title": "GitHub Copilot Business", "displayTitle": "Organization permissions for \"GitHub Copilot Business\"", "permissions": [ + { + "category": "copilot-spaces", + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "copilot-spaces", + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "copilot-spaces", + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "copilot-spaces", + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "copilot", "slug": "get-copilot-seat-information-and-settings-for-an-organization", diff --git a/src/github-apps/data/ghec-2026-03-10/server-to-server-rest.json b/src/github-apps/data/ghec-2026-03-10/server-to-server-rest.json index 509fb1c9ddaf..6341e24319e3 100644 --- a/src/github-apps/data/ghec-2026-03-10/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2026-03-10/server-to-server-rest.json @@ -2255,37 +2255,37 @@ "requestPath": "/orgs/{org}/copilot/billing/selected_users" }, { - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" }, { - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" @@ -2345,6 +2345,92 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], + "copilot-spaces": [ + { + "slug": "list-organization-copilot-spaces", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "create-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "get-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "set-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "delete-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "list-resources-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "create-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "get-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "set-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "delete-a-resource-from-an-organization-copilot-space", + "subcategory": "resources", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + } + ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-enterprise", diff --git a/src/github-apps/data/ghec-2026-03-10/user-to-server-rest.json b/src/github-apps/data/ghec-2026-03-10/user-to-server-rest.json index 3db3b14ea98d..793f8b615901 100644 --- a/src/github-apps/data/ghec-2026-03-10/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2026-03-10/user-to-server-rest.json @@ -2503,37 +2503,37 @@ "requestPath": "/orgs/{org}/copilot/billing/selected_users" }, { - "slug": "get-copilot-coding-agent-permissions-for-an-organization", + "slug": "get-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "set-copilot-coding-agent-permissions-for-an-organization", + "slug": "set-copilot-cloud-agent-permissions-for-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions" }, { - "slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization", + "slug": "list-repositories-enabled-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization", + "slug": "set-selected-repositories-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories" }, { - "slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "enable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" }, { - "slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization", + "slug": "disable-a-repository-for-copilot-cloud-agent-in-an-organization", "subcategory": "copilot-coding-agent-management", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}" @@ -2593,6 +2593,92 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], + "copilot-spaces": [ + { + "slug": "list-organization-copilot-spaces", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "create-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces" + }, + { + "slug": "get-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "set-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "delete-an-organization-copilot-space", + "subcategory": "copilot-spaces", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}" + }, + { + "slug": "list-collaborators-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "add-a-collaborator-to-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators" + }, + { + "slug": "set-a-collaborator-role-for-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "remove-a-collaborator-from-an-organization-copilot-space", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}" + }, + { + "slug": "list-resources-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "create-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources" + }, + { + "slug": "get-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "set-a-resource-for-an-organization-copilot-space", + "subcategory": "resources", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + }, + { + "slug": "delete-a-resource-from-an-organization-copilot-space", + "subcategory": "resources", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}" + } + ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-enterprise", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index e0ca8c5a762f..2ec27eb13dc2 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "d786d3f083a842b342a5395a58ca01cd0faa71e6" + "sha": "d3a3c2a50bb45b5f437bdfd8e0c700091bb1fb7b" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/actions.json b/src/rest/data/fpt-2022-11-28/actions.json index 289341eeadda..0a0b8005c020 100644 --- a/src/rest/data/fpt-2022-11-28/actions.json +++ b/src/rest/data/fpt-2022-11-28/actions.json @@ -5698,6 +5698,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } }, "required": [ @@ -5748,6 +5752,11 @@ "type": "array of strings", "name": "include_claim_keys", "description": "

Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.

" + }, + { + "type": "boolean", + "name": "use_immutable_subject", + "description": "

Whether to opt in to the immutable OIDC subject claim format for the organization. When true, new OIDC tokens will use a stable, repository-ID-based sub claim instead of the name-based format.

" } ], "descriptionHTML": "

Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", @@ -5873,6 +5882,14 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether the repository has opted in to the immutable OIDC subject claim format. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim. If not set at the repository level, falls back to the organization-level setting.", + "type": "boolean" + }, + "sub_claim_prefix": { + "description": "The current `sub` claim prefix for this repository.", + "type": "string" } }, "required": [ @@ -5947,6 +5964,11 @@ "type": "array of strings", "name": "include_claim_keys", "description": "

Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.

" + }, + { + "type": "boolean", + "name": "use_immutable_subject", + "description": "

Whether to opt in to the immutable OIDC subject claim format for this repository. When true, OIDC tokens will use a stable, repository-ID-based sub claim.

" } ], "descriptionHTML": "

Sets the customization template and opt-in or opt-out flag for an OpenID Connect (OIDC) subject claim for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", diff --git a/src/rest/data/fpt-2022-11-28/apps.json b/src/rest/data/fpt-2022-11-28/apps.json index ffd7173c7578..5e2e3056bbf6 100644 --- a/src/rest/data/fpt-2022-11-28/apps.json +++ b/src/rest/data/fpt-2022-11-28/apps.json @@ -1830,7 +1830,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -2783,7 +2783,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3543,7 +3543,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -4170,7 +4170,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -5532,7 +5532,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -6297,7 +6297,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7640,7 +7640,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -8603,7 +8603,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -9564,7 +9564,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -11523,7 +11523,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -15990,7 +15990,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -16925,7 +16925,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/fpt-2022-11-28/copilot-spaces.json b/src/rest/data/fpt-2022-11-28/copilot-spaces.json new file mode 100644 index 000000000000..c66dd40eb303 --- /dev/null +++ b/src/rest/data/fpt-2022-11-28/copilot-spaces.json @@ -0,0 +1,9766 @@ +{ + "copilot-spaces": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces", + "title": "List organization Copilot Spaces", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.

", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.

", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.

\n

Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for listing organization copilot spaces

", + "example": { + "spaces": [ + { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3" + }, + { + "id": 85, + "number": 4, + "name": "Development Resources", + "description": "Shared development documentation and resources", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/4", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/4" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "spaces" + ], + "properties": { + "spaces": { + "type": "array", + "description": "The list of Copilot Spaces on this page of results.", + "items": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces", + "title": "Create an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "

The name of the Copilot Space.

", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

A description of the Copilot Space.

" + }, + { + "type": "string", + "name": "general_instructions", + "description": "

General instructions for the Copilot Space.

" + }, + { + "type": "string", + "name": "base_role", + "description": "

The base role that determines default permissions for organization members.

\n", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "default": "no_access" + }, + { + "type": "array of objects", + "name": "resources_attributes", + "description": "

Resources to attach to the space.

", + "childParamsGroups": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource.

", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Metadata specific to the resource type.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "repository_id", + "description": "

Repository ID for repository or file resources.

" + }, + { + "type": "string", + "name": "file_path", + "description": "

File path for file resources.

" + }, + { + "type": "string", + "name": "text", + "description": "

Text content for free text resources.

" + }, + { + "type": "string", + "name": "name", + "description": "

Name for the resource.

" + }, + { + "type": "integer", + "name": "number", + "description": "

Issue or PR number.

" + } + ] + } + ] + } + ], + "descriptionHTML": "

Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.

\n

Organization members with appropriate permissions can create Copilot Spaces to be shared within their organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/planning.md" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology and holds daily standups" + } + } + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Example response for an organization copilot space

", + "example": { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}", + "title": "Get an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.

\n

Internal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for an organization copilot space

", + "example": { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}", + "title": "Set an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "

The name of the Copilot Space.

" + }, + { + "type": "string", + "name": "description", + "description": "

A description of the Copilot Space.

" + }, + { + "type": "string", + "name": "general_instructions", + "description": "

General instructions for the Copilot Space.

" + }, + { + "type": "string", + "name": "base_role", + "description": "

The base role that determines default permissions for organization members. Changing this field requires admin permissions.

\n", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ] + }, + { + "type": "array of objects", + "name": "resources_attributes", + "description": "

Resources to attach to the space.

", + "childParamsGroups": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource.

", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Metadata specific to the resource type.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "repository_id", + "description": "

Repository ID for repository or file resources.

" + }, + { + "type": "string", + "name": "file_path", + "description": "

File path for file resources.

" + }, + { + "type": "string", + "name": "text", + "description": "

Text content for free text resources.

" + }, + { + "type": "string", + "name": "name", + "description": "

Name for the resource.

" + }, + { + "type": "integer", + "name": "number", + "description": "

Issue or PR number.

" + } + ] + } + ] + } + ], + "descriptionHTML": "

Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.

\n

Organization members with appropriate permissions can update Copilot Spaces owned by their organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Updated Team Planning Space", + "description": "Updated organization space for team planning and coordination", + "general_instructions": "Updated instructions to help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/updated-planning.md" + } + }, + { + "id": 789, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Team Guidelines", + "text": "Our updated team follows agile methodology and holds daily standups" + } + } + ] + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for an organization copilot space

", + "example": { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}", + "title": "Delete an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.

\n

Warning: This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.

\n

Organization members with appropriate permissions can delete Copilot Spaces owned by their organization.

\n

OAuth app tokens and personal access tokens (classic) need both the read:org and repo scopes to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "204", + "description": "

The Copilot Space has been successfully deleted.

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

The Copilot Space has been successfully deleted.

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces", + "title": "List Copilot Spaces for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.

", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.

", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces.

\n

Only Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for listing user copilot spaces

", + "example": { + "spaces": [ + { + "id": 42, + "number": 1, + "name": "Personal Research Space", + "description": "My personal space for research and development", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/1", + "api_url": "https://api.github.com/user/1/copilot-spaces/1" + }, + { + "id": 43, + "number": 2, + "name": "Learning Space", + "description": "Space for learning new technologies", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-17T08:20:00Z", + "updated_at": "2023-02-17T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/2", + "api_url": "https://api.github.com/user/1/copilot-spaces/2" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "spaces" + ], + "properties": { + "spaces": { + "type": "array", + "description": "The list of Copilot Spaces on this page of results.", + "items": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/users/{username}/copilot-spaces", + "title": "Create a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "

The name of the Copilot Space.

", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

A description of the Copilot Space.

" + }, + { + "type": "string", + "name": "general_instructions", + "description": "

General instructions for the Copilot Space.

" + }, + { + "type": "string", + "name": "base_role", + "description": "

The base role that determines default permissions for the space.

\n", + "enum": [ + "reader", + "no_access" + ], + "default": "no_access" + }, + { + "type": "array of objects", + "name": "resources_attributes", + "description": "

Resources to attach to the space.

", + "childParamsGroups": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource.

", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Metadata specific to the resource type.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "repository_id", + "description": "

Repository ID for repository or file resources.

" + }, + { + "type": "string", + "name": "file_path", + "description": "

File path for file resources.

" + }, + { + "type": "string", + "name": "text", + "description": "

Text content for free text resources.

" + }, + { + "type": "string", + "name": "name", + "description": "

Name for the resource.

" + }, + { + "type": "integer", + "name": "number", + "description": "

Issue or PR number.

" + } + ] + } + ] + } + ], + "descriptionHTML": "

Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account.

\n

Users can create personal Copilot Spaces for their individual use.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "My Development Space", + "description": "Personal space for development assistance", + "general_instructions": "Help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/App.js" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Development Notes", + "text": "Focus on clean code principles and modern React patterns" + } + } + ] + }, + "parameters": { + "username": "USERNAME" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Example response for a user copilot space

", + "example": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces/{space_number}", + "title": "Get a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space.

\n

Private user spaces require the authenticated user to be the owner of the space.\nPublic user spaces are accessible to any authenticated user.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for a user copilot space

", + "example": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/users/{username}/copilot-spaces/{space_number}", + "title": "Set a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "

The name of the Copilot Space.

" + }, + { + "type": "string", + "name": "description", + "description": "

A description of the Copilot Space.

" + }, + { + "type": "string", + "name": "general_instructions", + "description": "

General instructions for the Copilot Space.

" + }, + { + "type": "string", + "name": "base_role", + "description": "

The base role that determines default permissions for the space. Changing this field requires admin permissions.

\n", + "enum": [ + "reader", + "no_access" + ] + }, + { + "type": "array of objects", + "name": "resources_attributes", + "description": "

Resources to attach to the space.

", + "childParamsGroups": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource.

", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Metadata specific to the resource type.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "repository_id", + "description": "

Repository ID for repository or file resources.

" + }, + { + "type": "string", + "name": "file_path", + "description": "

File path for file resources.

" + }, + { + "type": "string", + "name": "text", + "description": "

Text content for free text resources.

" + }, + { + "type": "string", + "name": "name", + "description": "

Name for the resource.

" + }, + { + "type": "integer", + "name": "number", + "description": "

Issue or PR number.

" + } + ] + } + ] + } + ], + "descriptionHTML": "

Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account.

\n

Users can update their personal Copilot Spaces.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Updated Development Space", + "description": "Updated personal space for development assistance", + "general_instructions": "Updated instructions to help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/UpdatedApp.js" + } + }, + { + "id": 123, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Development Notes", + "text": "Updated focus on clean code principles and modern React patterns" + } + } + ] + }, + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for a user copilot space

", + "example": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/users/{username}/copilot-spaces/{space_number}", + "title": "Delete a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space.

\n

Warning: This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "204", + "description": "

The Copilot Space has been successfully deleted.

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

The Copilot Space has been successfully deleted.

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + } + ], + "collaborators": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "title": "List collaborators for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.

\n

Each collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.

\n

Note: Team collaborators listed here are teams that are defined in the organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "collaborators": [ + { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + } + ] + }, + "schema": { + "type": "object", + "required": [ + "collaborators" + ], + "properties": { + "collaborators": { + "type": "array", + "description": "The list of collaborators for this Copilot Space.", + "items": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "title": "Add a collaborator to an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "actor_type", + "description": "

The type of actor (user or team).

", + "isRequired": true, + "enum": [ + "User", + "Team" + ] + }, + { + "type": "string", + "name": "actor_identifier", + "description": "

The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.

", + "isRequired": true + }, + { + "type": "string", + "name": "role", + "description": "

The role to grant to the collaborator.

", + "isRequired": true, + "enum": [ + "reader", + "writer", + "admin" + ] + } + ], + "descriptionHTML": "

Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.

\n

Note: When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example 1: Status Code 201", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + }, + { + "request": { + "contentType": "application/json", + "description": "Example 2: Status Code 201", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "actor_type": "Team", + "actor_identifier": "developers", + "role": "reader" + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "title": "Set a collaborator role for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "

The type of actor (user or team).

", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "

The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "role", + "description": "

The new role to grant to the collaborator. Use no_access to remove the collaborator.

", + "isRequired": true, + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ] + } + ], + "descriptionHTML": "

Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example 1: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "role": "admin" + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + }, + { + "request": { + "contentType": "application/json", + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "role": "admin" + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "Team", + "role": "admin", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "204", + "description": "

Response when role is no_access and the collaborator was removed.

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "title": "Remove a collaborator from an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "

The type of actor (user or team).

", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "

The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/collaborators", + "title": "List collaborators for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

\n

Each collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list.

\n

Team collaborators are not supported for user-owned Copilot Spaces.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "collaborators": [ + { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "User", + "role": "reader", + "login": "github-user", + "id": 67890, + "node_id": "MDQ6VXNlcjY3ODkw", + "avatar_url": "https://github.com/images/error/other_user.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github-user", + "html_url": "https://github.com/github-user", + "followers_url": "https://api.github.com/users/github-user/followers", + "following_url": "https://api.github.com/users/github-user/following{/other_user}", + "gists_url": "https://api.github.com/users/github-user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github-user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github-user/subscriptions", + "organizations_url": "https://api.github.com/users/github-user/orgs", + "repos_url": "https://api.github.com/users/github-user/repos", + "events_url": "https://api.github.com/users/github-user/events{/privacy}", + "received_events_url": "https://api.github.com/users/github-user/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "GitHub User", + "company": null, + "blog": "", + "location": null, + "email": null, + "hireable": null, + "bio": null, + "twitter_username": null, + "public_repos": 5, + "public_gists": 0, + "followers": 10, + "following": 5, + "created_at": "2010-01-14T04:33:35Z", + "updated_at": "2010-01-14T04:33:35Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "collaborators" + ], + "properties": { + "collaborators": { + "type": "array", + "description": "The list of collaborators for this Copilot Space.", + "items": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/collaborators", + "title": "Add a collaborator to a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "actor_type", + "description": "

The type of actor (must be User for user-owned spaces; Team will be rejected).

", + "isRequired": true, + "enum": [ + "User", + "Team" + ] + }, + { + "type": "string", + "name": "actor_identifier", + "description": "

The username of the collaborator. The numeric user ID is also accepted.

", + "isRequired": true + }, + { + "type": "string", + "name": "role", + "description": "

The role to grant to the collaborator.

", + "isRequired": true, + "enum": [ + "reader", + "writer", + "admin" + ] + } + ], + "descriptionHTML": "

Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

\n

Team collaborators are not supported for user-owned Copilot Spaces.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" + }, + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "title": "Set a collaborator role for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "

The type of actor (must be User for user-owned spaces; Team will be rejected).

", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "

The username of the collaborator. The numeric user ID is also accepted.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "role", + "description": "

The new role to grant to the collaborator. Use no_access to remove the collaborator.

", + "isRequired": true, + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ] + } + ], + "descriptionHTML": "

Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "role": "admin" + }, + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "204", + "description": "

Response when role is no_access and the collaborator was removed.

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "title": "Remove a collaborator from a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "

The type of actor (must be User for user-owned spaces; Team will be rejected).

", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "

The username of the collaborator. The numeric user ID is also accepted.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + } + ], + "resources": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources", + "title": "List resources for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "resources": [ + { + "id": 1, + "resource_type": "repository", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42 + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + { + "id": 2, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources", + "title": "Create a resource for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource to create.

", + "isRequired": true, + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Resource-specific metadata.

", + "isRequired": true + } + ], + "descriptionHTML": "

Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.

\n

The following resource types are supported: repository, github_file, free_text, github_issue, github_pull_request.\nThe uploaded_text_file and media_content types are not supported via this endpoint.

\n

For github_file resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a 200 status.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Duplicate github_file resource already exists

" + }, + { + "httpStatusCode": "201", + "description": "

Resource created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Get a resource for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Set a resource for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "object", + "name": "metadata", + "description": "

Updated resource-specific metadata.

" + } + ], + "descriptionHTML": "

Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" + }, + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Delete a resource from an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources", + "title": "List resources for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists all resources attached to a specific Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "resources": [ + { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources", + "title": "Create a resource for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource to create.

", + "isRequired": true, + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Resource-specific metadata.

", + "isRequired": true + } + ], + "descriptionHTML": "

Creates a new resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.

\n

The following resource types are supported: repository, github_file, free_text, github_issue, github_pull_request.\nThe uploaded_text_file and media_content types are not supported via this endpoint.

\n

For github_file resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a 200 status.

\n

OAuth app tokens and personal access tokens (classic) need the write:user scope to use this endpoint.

", + "codeExamples": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Duplicate github_file resource already exists

" + }, + { + "httpStatusCode": "201", + "description": "

Resource created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Get a resource for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Gets a specific resource attached to a Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Set a resource for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "object", + "name": "metadata", + "description": "

Updated resource-specific metadata.

" + } + ], + "descriptionHTML": "

Updates the metadata of a resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.

\n

OAuth app tokens and personal access tokens (classic) need the write:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + }, + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" + }, + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Delete a resource from a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes a resource from a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.

\n

OAuth app tokens and personal access tokens (classic) need the write:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + } + ] +} \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/copilot.json b/src/rest/data/fpt-2022-11-28/copilot.json index d382cf3c7647..eef157d3dcfc 100644 --- a/src/rest/data/fpt-2022-11-28/copilot.json +++ b/src/rest/data/fpt-2022-11-28/copilot.json @@ -22,7 +22,7 @@ { "type": "string", "name": "policy_state", - "description": "

The policy state for Copilot coding agent in the enterprise. Can be one of enabled_for_all_orgs, disabled_for_all_orgs, enabled_for_selected_orgs, or configured_by_org_admins.

", + "description": "

The policy state for Copilot cloud agent in the enterprise. Can be one of enabled_for_all_orgs, disabled_for_all_orgs, enabled_for_selected_orgs, or configured_by_org_admins.

", "isRequired": true, "enum": [ "enabled_for_all_orgs", @@ -32,7 +32,7 @@ ] } ], - "descriptionHTML": "

Sets the policy for Copilot coding agent usage across an enterprise.

\n

Enterprise owners can configure whether Copilot coding agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.

\n

Only enterprise owners can set the coding agent policy for their enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Sets the policy for Copilot cloud agent usage across an enterprise.

\n

Enterprise owners can configure whether Copilot cloud agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.

\n

Only enterprise owners can set the coding agent policy for their enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -92,7 +92,7 @@ { "type": "array of strings", "name": "organizations", - "description": "

List of organization logins within the enterprise to enable Copilot coding agent for.

" + "description": "

List of organization logins within the enterprise to enable Copilot cloud agent for.

" }, { "type": "array of objects", @@ -114,7 +114,7 @@ ] } ], - "descriptionHTML": "

Enables Copilot coding agent for the specified organizations within the enterprise.

\n

The enterprise's coding agent policy must be set to enabled_for_selected_orgs before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.

\n

Only organizations that have Copilot enabled and belong to the enterprise will be affected.

\n

Only enterprise owners can add organizations to the coding agent policy.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Enables Copilot cloud agent for the specified organizations within the enterprise.

\n

The enterprise's coding agent policy must be set to enabled_for_selected_orgs before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.

\n

Only organizations that have Copilot enabled and belong to the enterprise will be affected.

\n

Only enterprise owners can add organizations to the coding agent policy.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -186,7 +186,7 @@ { "type": "array of strings", "name": "organizations", - "description": "

List of organization logins within the enterprise to disable Copilot coding agent for.

" + "description": "

List of organization logins within the enterprise to disable Copilot cloud agent for.

" }, { "type": "array of objects", @@ -208,7 +208,7 @@ ] } ], - "descriptionHTML": "

Disables Copilot coding agent for the specified organizations within the enterprise.

\n

The enterprise's coding agent policy must be set to enabled_for_selected_orgs before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.

\n

Only organizations that have Copilot enabled and belong to the enterprise will be affected.

\n

Only enterprise owners can remove organizations from the coding agent policy.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Disables Copilot cloud agent for the specified organizations within the enterprise.

\n

The enterprise's coding agent policy must be set to enabled_for_selected_orgs before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.

\n

Only organizations that have Copilot enabled and belong to the enterprise will be affected.

\n

Only enterprise owners can remove organizations from the coding agent policy.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -262,7 +262,7 @@ "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", - "title": "Get Copilot coding agent permissions for an organization", + "title": "Get Copilot cloud agent permissions for an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -277,7 +277,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about which repositories in an organization have been enabled\nor disabled for the Copilot coding agent.

\n

Organization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about which repositories in an organization have been enabled\nor disabled for the Copilot cloud agent.

\n

Organization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -299,7 +299,7 @@ "properties": { "enabled_repositories": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", "selected", @@ -338,7 +338,7 @@ "properties": { "enabled_repositories": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", "selected", @@ -376,7 +376,7 @@ "properties": { "enabled_repositories": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", "selected", @@ -433,7 +433,7 @@ "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", - "title": "Set Copilot coding agent permissions for an organization", + "title": "Set Copilot cloud agent permissions for an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -451,7 +451,7 @@ { "type": "string", "name": "enabled_repositories", - "description": "

The policy for which repositories can use Copilot coding agent. Can be one of all, selected, or none.

", + "description": "

The policy for which repositories can use Copilot cloud agent. Can be one of all, selected, or none.

", "isRequired": true, "enum": [ "all", @@ -460,7 +460,7 @@ ] } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets the policy for which repositories in an organization can use Copilot coding agent.

\n

Organization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets the policy for which repositories in an organization can use Copilot cloud agent.

\n

Organization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -522,7 +522,7 @@ "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", - "title": "List repositories enabled for Copilot coding agent in an organization", + "title": "List repositories enabled for Copilot cloud agent in an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -555,7 +555,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists the selected repositories that are enabled for Copilot coding agent in an organization.

\n

Organization owners can use this endpoint when the coding agent repository policy\nis set to selected to see which repositories have been enabled.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists the selected repositories that are enabled for Copilot cloud agent in an organization.

\n

Organization owners can use this endpoint when the coding agent repository policy\nis set to selected to see which repositories have been enabled.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -1584,7 +1584,7 @@ "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", - "title": "Set selected repositories for Copilot coding agent in an organization", + "title": "Set selected repositories for Copilot cloud agent in an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -1602,11 +1602,11 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

List of repository IDs to enable for Copilot coding agent.

", + "description": "

List of repository IDs to enable for Copilot cloud agent.

", "isRequired": true } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Replaces the list of selected repositories that are enabled for Copilot coding\nagent in an organization. This method can only be called when the coding agent\nrepository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Replaces the list of selected repositories that are enabled for Copilot cloud\nagent in an organization. This method can only be called when the cloud agent\nrepository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -1675,7 +1675,7 @@ "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", - "title": "Enable a repository for Copilot coding agent in an organization", + "title": "Enable a repository for Copilot cloud agent in an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -1699,7 +1699,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Adds a repository to the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Adds a repository to the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -1763,7 +1763,7 @@ "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", - "title": "Disable a repository for Copilot coding agent in an organization", + "title": "Disable a repository for Copilot cloud agent in an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -1787,7 +1787,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Removes a repository from the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Removes a repository from the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scopes to use this endpoint.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/fpt-2022-11-28/orgs.json b/src/rest/data/fpt-2022-11-28/orgs.json index e46c02ec97f0..08510d45c578 100644 --- a/src/rest/data/fpt-2022-11-28/orgs.json +++ b/src/rest/data/fpt-2022-11-28/orgs.json @@ -1928,7 +1928,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/fpt-2022-11-28/secret-scanning.json b/src/rest/data/fpt-2022-11-28/secret-scanning.json index e40e991136f2..44e82856f993 100644 --- a/src/rest/data/fpt-2022-11-28/secret-scanning.json +++ b/src/rest/data/fpt-2022-11-28/secret-scanning.json @@ -4641,6 +4641,16 @@ "type": "string or null", "name": "assignee", "description": "

The username of the user to assign to the alert. Set to null to unassign the alert.

" + }, + { + "type": "string or null", + "name": "validity", + "description": "

Sets the validity of the secret scanning alert. Can be active, inactive, or null to clear the override.

", + "enum": [ + "active", + "inactive", + null + ] } ], "descriptionHTML": "

Updates the status of a secret scanning alert in an eligible repository.

\n

You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.

\n

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

", @@ -5847,7 +5857,7 @@ }, { "httpStatusCode": "422", - "description": "

State does not match the resolution or resolution comment, or assignee does not have write access to the repository

" + "description": "

State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert

" }, { "httpStatusCode": "503", diff --git a/src/rest/data/fpt-2026-03-10/actions.json b/src/rest/data/fpt-2026-03-10/actions.json index c8dfa8ffd349..044ce0c19d67 100644 --- a/src/rest/data/fpt-2026-03-10/actions.json +++ b/src/rest/data/fpt-2026-03-10/actions.json @@ -5698,6 +5698,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } }, "required": [ @@ -5748,6 +5752,11 @@ "type": "array of strings", "name": "include_claim_keys", "description": "

Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.

" + }, + { + "type": "boolean", + "name": "use_immutable_subject", + "description": "

Whether to opt in to the immutable OIDC subject claim format for the organization. When true, new OIDC tokens will use a stable, repository-ID-based sub claim instead of the name-based format.

" } ], "descriptionHTML": "

Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", @@ -5873,6 +5882,14 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether the repository has opted in to the immutable OIDC subject claim format. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim. If not set at the repository level, falls back to the organization-level setting.", + "type": "boolean" + }, + "sub_claim_prefix": { + "description": "The current `sub` claim prefix for this repository.", + "type": "string" } }, "required": [ @@ -5947,6 +5964,11 @@ "type": "array of strings", "name": "include_claim_keys", "description": "

Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.

" + }, + { + "type": "boolean", + "name": "use_immutable_subject", + "description": "

Whether to opt in to the immutable OIDC subject claim format for this repository. When true, OIDC tokens will use a stable, repository-ID-based sub claim.

" } ], "descriptionHTML": "

Sets the customization template and opt-in or opt-out flag for an OpenID Connect (OIDC) subject claim for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", @@ -39492,7 +39514,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response including the workflow run ID and URLs when return_run_details parameter is true.

", + "description": "

Response including the workflow run ID and URLs.

", "example": { "workflow_run_id": 1, "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1", @@ -39531,7 +39553,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

Response including the workflow run ID and URLs when return_run_details parameter is true.

" + "description": "

Response including the workflow run ID and URLs.

" } ], "previews": [], diff --git a/src/rest/data/fpt-2026-03-10/apps.json b/src/rest/data/fpt-2026-03-10/apps.json index c903c5448fd9..80f19374f275 100644 --- a/src/rest/data/fpt-2026-03-10/apps.json +++ b/src/rest/data/fpt-2026-03-10/apps.json @@ -1830,7 +1830,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -2783,7 +2783,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3543,7 +3543,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -4170,7 +4170,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -5516,7 +5516,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -6281,7 +6281,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7624,7 +7624,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -8587,7 +8587,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -9548,7 +9548,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -11491,7 +11491,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -15942,7 +15942,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -16877,7 +16877,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/fpt-2026-03-10/copilot-spaces.json b/src/rest/data/fpt-2026-03-10/copilot-spaces.json new file mode 100644 index 000000000000..c66dd40eb303 --- /dev/null +++ b/src/rest/data/fpt-2026-03-10/copilot-spaces.json @@ -0,0 +1,9766 @@ +{ + "copilot-spaces": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces", + "title": "List organization Copilot Spaces", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.

", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.

", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.

\n

Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for listing organization copilot spaces

", + "example": { + "spaces": [ + { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3" + }, + { + "id": 85, + "number": 4, + "name": "Development Resources", + "description": "Shared development documentation and resources", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/4", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/4" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "spaces" + ], + "properties": { + "spaces": { + "type": "array", + "description": "The list of Copilot Spaces on this page of results.", + "items": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces", + "title": "Create an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "

The name of the Copilot Space.

", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

A description of the Copilot Space.

" + }, + { + "type": "string", + "name": "general_instructions", + "description": "

General instructions for the Copilot Space.

" + }, + { + "type": "string", + "name": "base_role", + "description": "

The base role that determines default permissions for organization members.

\n", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "default": "no_access" + }, + { + "type": "array of objects", + "name": "resources_attributes", + "description": "

Resources to attach to the space.

", + "childParamsGroups": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource.

", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Metadata specific to the resource type.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "repository_id", + "description": "

Repository ID for repository or file resources.

" + }, + { + "type": "string", + "name": "file_path", + "description": "

File path for file resources.

" + }, + { + "type": "string", + "name": "text", + "description": "

Text content for free text resources.

" + }, + { + "type": "string", + "name": "name", + "description": "

Name for the resource.

" + }, + { + "type": "integer", + "name": "number", + "description": "

Issue or PR number.

" + } + ] + } + ] + } + ], + "descriptionHTML": "

Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.

\n

Organization members with appropriate permissions can create Copilot Spaces to be shared within their organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/planning.md" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology and holds daily standups" + } + } + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Example response for an organization copilot space

", + "example": { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}", + "title": "Get an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.

\n

Internal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for an organization copilot space

", + "example": { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}", + "title": "Set an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "

The name of the Copilot Space.

" + }, + { + "type": "string", + "name": "description", + "description": "

A description of the Copilot Space.

" + }, + { + "type": "string", + "name": "general_instructions", + "description": "

General instructions for the Copilot Space.

" + }, + { + "type": "string", + "name": "base_role", + "description": "

The base role that determines default permissions for organization members. Changing this field requires admin permissions.

\n", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ] + }, + { + "type": "array of objects", + "name": "resources_attributes", + "description": "

Resources to attach to the space.

", + "childParamsGroups": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource.

", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Metadata specific to the resource type.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "repository_id", + "description": "

Repository ID for repository or file resources.

" + }, + { + "type": "string", + "name": "file_path", + "description": "

File path for file resources.

" + }, + { + "type": "string", + "name": "text", + "description": "

Text content for free text resources.

" + }, + { + "type": "string", + "name": "name", + "description": "

Name for the resource.

" + }, + { + "type": "integer", + "name": "number", + "description": "

Issue or PR number.

" + } + ] + } + ] + } + ], + "descriptionHTML": "

Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.

\n

Organization members with appropriate permissions can update Copilot Spaces owned by their organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Updated Team Planning Space", + "description": "Updated organization space for team planning and coordination", + "general_instructions": "Updated instructions to help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/updated-planning.md" + } + }, + { + "id": 789, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Team Guidelines", + "text": "Our updated team follows agile methodology and holds daily standups" + } + } + ] + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for an organization copilot space

", + "example": { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}", + "title": "Delete an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.

\n

Warning: This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.

\n

Organization members with appropriate permissions can delete Copilot Spaces owned by their organization.

\n

OAuth app tokens and personal access tokens (classic) need both the read:org and repo scopes to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "204", + "description": "

The Copilot Space has been successfully deleted.

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

The Copilot Space has been successfully deleted.

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces", + "title": "List Copilot Spaces for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.

", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.

", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces.

\n

Only Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for listing user copilot spaces

", + "example": { + "spaces": [ + { + "id": 42, + "number": 1, + "name": "Personal Research Space", + "description": "My personal space for research and development", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/1", + "api_url": "https://api.github.com/user/1/copilot-spaces/1" + }, + { + "id": 43, + "number": 2, + "name": "Learning Space", + "description": "Space for learning new technologies", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-17T08:20:00Z", + "updated_at": "2023-02-17T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/2", + "api_url": "https://api.github.com/user/1/copilot-spaces/2" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "spaces" + ], + "properties": { + "spaces": { + "type": "array", + "description": "The list of Copilot Spaces on this page of results.", + "items": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/users/{username}/copilot-spaces", + "title": "Create a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "

The name of the Copilot Space.

", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

A description of the Copilot Space.

" + }, + { + "type": "string", + "name": "general_instructions", + "description": "

General instructions for the Copilot Space.

" + }, + { + "type": "string", + "name": "base_role", + "description": "

The base role that determines default permissions for the space.

\n", + "enum": [ + "reader", + "no_access" + ], + "default": "no_access" + }, + { + "type": "array of objects", + "name": "resources_attributes", + "description": "

Resources to attach to the space.

", + "childParamsGroups": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource.

", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Metadata specific to the resource type.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "repository_id", + "description": "

Repository ID for repository or file resources.

" + }, + { + "type": "string", + "name": "file_path", + "description": "

File path for file resources.

" + }, + { + "type": "string", + "name": "text", + "description": "

Text content for free text resources.

" + }, + { + "type": "string", + "name": "name", + "description": "

Name for the resource.

" + }, + { + "type": "integer", + "name": "number", + "description": "

Issue or PR number.

" + } + ] + } + ] + } + ], + "descriptionHTML": "

Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account.

\n

Users can create personal Copilot Spaces for their individual use.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "My Development Space", + "description": "Personal space for development assistance", + "general_instructions": "Help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/App.js" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Development Notes", + "text": "Focus on clean code principles and modern React patterns" + } + } + ] + }, + "parameters": { + "username": "USERNAME" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Example response for a user copilot space

", + "example": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces/{space_number}", + "title": "Get a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space.

\n

Private user spaces require the authenticated user to be the owner of the space.\nPublic user spaces are accessible to any authenticated user.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for a user copilot space

", + "example": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/users/{username}/copilot-spaces/{space_number}", + "title": "Set a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "

The name of the Copilot Space.

" + }, + { + "type": "string", + "name": "description", + "description": "

A description of the Copilot Space.

" + }, + { + "type": "string", + "name": "general_instructions", + "description": "

General instructions for the Copilot Space.

" + }, + { + "type": "string", + "name": "base_role", + "description": "

The base role that determines default permissions for the space. Changing this field requires admin permissions.

\n", + "enum": [ + "reader", + "no_access" + ] + }, + { + "type": "array of objects", + "name": "resources_attributes", + "description": "

Resources to attach to the space.

", + "childParamsGroups": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource.

", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Metadata specific to the resource type.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "repository_id", + "description": "

Repository ID for repository or file resources.

" + }, + { + "type": "string", + "name": "file_path", + "description": "

File path for file resources.

" + }, + { + "type": "string", + "name": "text", + "description": "

Text content for free text resources.

" + }, + { + "type": "string", + "name": "name", + "description": "

Name for the resource.

" + }, + { + "type": "integer", + "name": "number", + "description": "

Issue or PR number.

" + } + ] + } + ] + } + ], + "descriptionHTML": "

Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account.

\n

Users can update their personal Copilot Spaces.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Updated Development Space", + "description": "Updated personal space for development assistance", + "general_instructions": "Updated instructions to help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/UpdatedApp.js" + } + }, + { + "id": 123, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Development Notes", + "text": "Updated focus on clean code principles and modern React patterns" + } + } + ] + }, + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for a user copilot space

", + "example": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/users/{username}/copilot-spaces/{space_number}", + "title": "Delete a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space.

\n

Warning: This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "204", + "description": "

The Copilot Space has been successfully deleted.

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

The Copilot Space has been successfully deleted.

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + } + ], + "collaborators": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "title": "List collaborators for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.

\n

Each collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.

\n

Note: Team collaborators listed here are teams that are defined in the organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "collaborators": [ + { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + } + ] + }, + "schema": { + "type": "object", + "required": [ + "collaborators" + ], + "properties": { + "collaborators": { + "type": "array", + "description": "The list of collaborators for this Copilot Space.", + "items": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "title": "Add a collaborator to an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "actor_type", + "description": "

The type of actor (user or team).

", + "isRequired": true, + "enum": [ + "User", + "Team" + ] + }, + { + "type": "string", + "name": "actor_identifier", + "description": "

The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.

", + "isRequired": true + }, + { + "type": "string", + "name": "role", + "description": "

The role to grant to the collaborator.

", + "isRequired": true, + "enum": [ + "reader", + "writer", + "admin" + ] + } + ], + "descriptionHTML": "

Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.

\n

Note: When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example 1: Status Code 201", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + }, + { + "request": { + "contentType": "application/json", + "description": "Example 2: Status Code 201", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "actor_type": "Team", + "actor_identifier": "developers", + "role": "reader" + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "title": "Set a collaborator role for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "

The type of actor (user or team).

", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "

The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "role", + "description": "

The new role to grant to the collaborator. Use no_access to remove the collaborator.

", + "isRequired": true, + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ] + } + ], + "descriptionHTML": "

Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example 1: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "role": "admin" + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + }, + { + "request": { + "contentType": "application/json", + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "role": "admin" + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "Team", + "role": "admin", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "204", + "description": "

Response when role is no_access and the collaborator was removed.

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "title": "Remove a collaborator from an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "

The type of actor (user or team).

", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "

The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/collaborators", + "title": "List collaborators for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

\n

Each collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list.

\n

Team collaborators are not supported for user-owned Copilot Spaces.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "collaborators": [ + { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "User", + "role": "reader", + "login": "github-user", + "id": 67890, + "node_id": "MDQ6VXNlcjY3ODkw", + "avatar_url": "https://github.com/images/error/other_user.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github-user", + "html_url": "https://github.com/github-user", + "followers_url": "https://api.github.com/users/github-user/followers", + "following_url": "https://api.github.com/users/github-user/following{/other_user}", + "gists_url": "https://api.github.com/users/github-user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github-user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github-user/subscriptions", + "organizations_url": "https://api.github.com/users/github-user/orgs", + "repos_url": "https://api.github.com/users/github-user/repos", + "events_url": "https://api.github.com/users/github-user/events{/privacy}", + "received_events_url": "https://api.github.com/users/github-user/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "GitHub User", + "company": null, + "blog": "", + "location": null, + "email": null, + "hireable": null, + "bio": null, + "twitter_username": null, + "public_repos": 5, + "public_gists": 0, + "followers": 10, + "following": 5, + "created_at": "2010-01-14T04:33:35Z", + "updated_at": "2010-01-14T04:33:35Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "collaborators" + ], + "properties": { + "collaborators": { + "type": "array", + "description": "The list of collaborators for this Copilot Space.", + "items": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/collaborators", + "title": "Add a collaborator to a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "actor_type", + "description": "

The type of actor (must be User for user-owned spaces; Team will be rejected).

", + "isRequired": true, + "enum": [ + "User", + "Team" + ] + }, + { + "type": "string", + "name": "actor_identifier", + "description": "

The username of the collaborator. The numeric user ID is also accepted.

", + "isRequired": true + }, + { + "type": "string", + "name": "role", + "description": "

The role to grant to the collaborator.

", + "isRequired": true, + "enum": [ + "reader", + "writer", + "admin" + ] + } + ], + "descriptionHTML": "

Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

\n

Team collaborators are not supported for user-owned Copilot Spaces.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" + }, + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "title": "Set a collaborator role for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "

The type of actor (must be User for user-owned spaces; Team will be rejected).

", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "

The username of the collaborator. The numeric user ID is also accepted.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "role", + "description": "

The new role to grant to the collaborator. Use no_access to remove the collaborator.

", + "isRequired": true, + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ] + } + ], + "descriptionHTML": "

Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "role": "admin" + }, + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "204", + "description": "

Response when role is no_access and the collaborator was removed.

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "title": "Remove a collaborator from a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "

The type of actor (must be User for user-owned spaces; Team will be rejected).

", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "

The username of the collaborator. The numeric user ID is also accepted.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + } + ], + "resources": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources", + "title": "List resources for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "resources": [ + { + "id": 1, + "resource_type": "repository", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42 + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + { + "id": 2, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources", + "title": "Create a resource for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource to create.

", + "isRequired": true, + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Resource-specific metadata.

", + "isRequired": true + } + ], + "descriptionHTML": "

Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.

\n

The following resource types are supported: repository, github_file, free_text, github_issue, github_pull_request.\nThe uploaded_text_file and media_content types are not supported via this endpoint.

\n

For github_file resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a 200 status.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Duplicate github_file resource already exists

" + }, + { + "httpStatusCode": "201", + "description": "

Resource created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Get a resource for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Set a resource for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "object", + "name": "metadata", + "description": "

Updated resource-specific metadata.

" + } + ], + "descriptionHTML": "

Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" + }, + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Delete a resource from an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources", + "title": "List resources for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists all resources attached to a specific Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "resources": [ + { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources", + "title": "Create a resource for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource to create.

", + "isRequired": true, + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Resource-specific metadata.

", + "isRequired": true + } + ], + "descriptionHTML": "

Creates a new resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.

\n

The following resource types are supported: repository, github_file, free_text, github_issue, github_pull_request.\nThe uploaded_text_file and media_content types are not supported via this endpoint.

\n

For github_file resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a 200 status.

\n

OAuth app tokens and personal access tokens (classic) need the write:user scope to use this endpoint.

", + "codeExamples": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Duplicate github_file resource already exists

" + }, + { + "httpStatusCode": "201", + "description": "

Resource created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Get a resource for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Gets a specific resource attached to a Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Set a resource for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "object", + "name": "metadata", + "description": "

Updated resource-specific metadata.

" + } + ], + "descriptionHTML": "

Updates the metadata of a resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.

\n

OAuth app tokens and personal access tokens (classic) need the write:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + }, + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" + }, + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Delete a resource from a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes a resource from a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.

\n

OAuth app tokens and personal access tokens (classic) need the write:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + } + ] +} \ No newline at end of file diff --git a/src/rest/data/fpt-2026-03-10/copilot.json b/src/rest/data/fpt-2026-03-10/copilot.json index 799f4dc71cdd..b9ef1ae71611 100644 --- a/src/rest/data/fpt-2026-03-10/copilot.json +++ b/src/rest/data/fpt-2026-03-10/copilot.json @@ -22,7 +22,7 @@ { "type": "string", "name": "policy_state", - "description": "

The policy state for Copilot coding agent in the enterprise. Can be one of enabled_for_all_orgs, disabled_for_all_orgs, enabled_for_selected_orgs, or configured_by_org_admins.

", + "description": "

The policy state for Copilot cloud agent in the enterprise. Can be one of enabled_for_all_orgs, disabled_for_all_orgs, enabled_for_selected_orgs, or configured_by_org_admins.

", "isRequired": true, "enum": [ "enabled_for_all_orgs", @@ -32,7 +32,7 @@ ] } ], - "descriptionHTML": "

Sets the policy for Copilot coding agent usage across an enterprise.

\n

Enterprise owners can configure whether Copilot coding agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.

\n

Only enterprise owners can set the coding agent policy for their enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Sets the policy for Copilot cloud agent usage across an enterprise.

\n

Enterprise owners can configure whether Copilot cloud agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.

\n

Only enterprise owners can set the coding agent policy for their enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -92,7 +92,7 @@ { "type": "array of strings", "name": "organizations", - "description": "

List of organization logins within the enterprise to enable Copilot coding agent for.

" + "description": "

List of organization logins within the enterprise to enable Copilot cloud agent for.

" }, { "type": "array of objects", @@ -114,7 +114,7 @@ ] } ], - "descriptionHTML": "

Enables Copilot coding agent for the specified organizations within the enterprise.

\n

The enterprise's coding agent policy must be set to enabled_for_selected_orgs before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.

\n

Only organizations that have Copilot enabled and belong to the enterprise will be affected.

\n

Only enterprise owners can add organizations to the coding agent policy.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Enables Copilot cloud agent for the specified organizations within the enterprise.

\n

The enterprise's coding agent policy must be set to enabled_for_selected_orgs before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.

\n

Only organizations that have Copilot enabled and belong to the enterprise will be affected.

\n

Only enterprise owners can add organizations to the coding agent policy.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -186,7 +186,7 @@ { "type": "array of strings", "name": "organizations", - "description": "

List of organization logins within the enterprise to disable Copilot coding agent for.

" + "description": "

List of organization logins within the enterprise to disable Copilot cloud agent for.

" }, { "type": "array of objects", @@ -208,7 +208,7 @@ ] } ], - "descriptionHTML": "

Disables Copilot coding agent for the specified organizations within the enterprise.

\n

The enterprise's coding agent policy must be set to enabled_for_selected_orgs before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.

\n

Only organizations that have Copilot enabled and belong to the enterprise will be affected.

\n

Only enterprise owners can remove organizations from the coding agent policy.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Disables Copilot cloud agent for the specified organizations within the enterprise.

\n

The enterprise's coding agent policy must be set to enabled_for_selected_orgs before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.

\n

Only organizations that have Copilot enabled and belong to the enterprise will be affected.

\n

Only enterprise owners can remove organizations from the coding agent policy.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -262,7 +262,7 @@ "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", - "title": "Get Copilot coding agent permissions for an organization", + "title": "Get Copilot cloud agent permissions for an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -277,7 +277,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about which repositories in an organization have been enabled\nor disabled for the Copilot coding agent.

\n

Organization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about which repositories in an organization have been enabled\nor disabled for the Copilot cloud agent.

\n

Organization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -299,7 +299,7 @@ "properties": { "enabled_repositories": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", "selected", @@ -338,7 +338,7 @@ "properties": { "enabled_repositories": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", "selected", @@ -376,7 +376,7 @@ "properties": { "enabled_repositories": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", "selected", @@ -433,7 +433,7 @@ "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", - "title": "Set Copilot coding agent permissions for an organization", + "title": "Set Copilot cloud agent permissions for an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -451,7 +451,7 @@ { "type": "string", "name": "enabled_repositories", - "description": "

The policy for which repositories can use Copilot coding agent. Can be one of all, selected, or none.

", + "description": "

The policy for which repositories can use Copilot cloud agent. Can be one of all, selected, or none.

", "isRequired": true, "enum": [ "all", @@ -460,7 +460,7 @@ ] } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets the policy for which repositories in an organization can use Copilot coding agent.

\n

Organization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets the policy for which repositories in an organization can use Copilot cloud agent.

\n

Organization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -522,7 +522,7 @@ "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", - "title": "List repositories enabled for Copilot coding agent in an organization", + "title": "List repositories enabled for Copilot cloud agent in an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -555,7 +555,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists the selected repositories that are enabled for Copilot coding agent in an organization.

\n

Organization owners can use this endpoint when the coding agent repository policy\nis set to selected to see which repositories have been enabled.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists the selected repositories that are enabled for Copilot cloud agent in an organization.

\n

Organization owners can use this endpoint when the coding agent repository policy\nis set to selected to see which repositories have been enabled.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -1581,7 +1581,7 @@ "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", - "title": "Set selected repositories for Copilot coding agent in an organization", + "title": "Set selected repositories for Copilot cloud agent in an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -1599,11 +1599,11 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

List of repository IDs to enable for Copilot coding agent.

", + "description": "

List of repository IDs to enable for Copilot cloud agent.

", "isRequired": true } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Replaces the list of selected repositories that are enabled for Copilot coding\nagent in an organization. This method can only be called when the coding agent\nrepository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Replaces the list of selected repositories that are enabled for Copilot cloud\nagent in an organization. This method can only be called when the cloud agent\nrepository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -1672,7 +1672,7 @@ "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", - "title": "Enable a repository for Copilot coding agent in an organization", + "title": "Enable a repository for Copilot cloud agent in an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -1696,7 +1696,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Adds a repository to the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Adds a repository to the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -1760,7 +1760,7 @@ "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", - "title": "Disable a repository for Copilot coding agent in an organization", + "title": "Disable a repository for Copilot cloud agent in an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -1784,7 +1784,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Removes a repository from the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Removes a repository from the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scopes to use this endpoint.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/fpt-2026-03-10/orgs.json b/src/rest/data/fpt-2026-03-10/orgs.json index c2e4f2f3e193..77e8e98d98b3 100644 --- a/src/rest/data/fpt-2026-03-10/orgs.json +++ b/src/rest/data/fpt-2026-03-10/orgs.json @@ -1917,7 +1917,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/fpt-2026-03-10/secret-scanning.json b/src/rest/data/fpt-2026-03-10/secret-scanning.json index e40e991136f2..44e82856f993 100644 --- a/src/rest/data/fpt-2026-03-10/secret-scanning.json +++ b/src/rest/data/fpt-2026-03-10/secret-scanning.json @@ -4641,6 +4641,16 @@ "type": "string or null", "name": "assignee", "description": "

The username of the user to assign to the alert. Set to null to unassign the alert.

" + }, + { + "type": "string or null", + "name": "validity", + "description": "

Sets the validity of the secret scanning alert. Can be active, inactive, or null to clear the override.

", + "enum": [ + "active", + "inactive", + null + ] } ], "descriptionHTML": "

Updates the status of a secret scanning alert in an eligible repository.

\n

You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.

\n

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

", @@ -5847,7 +5857,7 @@ }, { "httpStatusCode": "422", - "description": "

State does not match the resolution or resolution comment, or assignee does not have write access to the repository

" + "description": "

State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert

" }, { "httpStatusCode": "503", diff --git a/src/rest/data/ghec-2022-11-28/actions.json b/src/rest/data/ghec-2022-11-28/actions.json index 6fec9e56cecc..f20d151c5765 100644 --- a/src/rest/data/ghec-2022-11-28/actions.json +++ b/src/rest/data/ghec-2022-11-28/actions.json @@ -8347,6 +8347,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } }, "required": [ @@ -8397,6 +8401,11 @@ "type": "array of strings", "name": "include_claim_keys", "description": "

Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.

" + }, + { + "type": "boolean", + "name": "use_immutable_subject", + "description": "

Whether to opt in to the immutable OIDC subject claim format for the organization. When true, new OIDC tokens will use a stable, repository-ID-based sub claim instead of the name-based format.

" } ], "descriptionHTML": "

Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", @@ -8522,6 +8531,14 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether the repository has opted in to the immutable OIDC subject claim format. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim. If not set at the repository level, falls back to the organization-level setting.", + "type": "boolean" + }, + "sub_claim_prefix": { + "description": "The current `sub` claim prefix for this repository.", + "type": "string" } }, "required": [ @@ -8596,6 +8613,11 @@ "type": "array of strings", "name": "include_claim_keys", "description": "

Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.

" + }, + { + "type": "boolean", + "name": "use_immutable_subject", + "description": "

Whether to opt in to the immutable OIDC subject claim format for this repository. When true, OIDC tokens will use a stable, repository-ID-based sub claim.

" } ], "descriptionHTML": "

Sets the customization template and opt-in or opt-out flag for an OpenID Connect (OIDC) subject claim for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", diff --git a/src/rest/data/ghec-2022-11-28/announcement-banners.json b/src/rest/data/ghec-2022-11-28/announcement-banners.json index 4dca133fde21..3cc624155a9a 100644 --- a/src/rest/data/ghec-2022-11-28/announcement-banners.json +++ b/src/rest/data/ghec-2022-11-28/announcement-banners.json @@ -48,7 +48,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" }, "expires_at": { "type": [ @@ -162,7 +162,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" }, "expires_at": { "type": [ @@ -303,7 +303,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" }, "expires_at": { "type": [ @@ -421,7 +421,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" }, "expires_at": { "type": [ diff --git a/src/rest/data/ghec-2022-11-28/apps.json b/src/rest/data/ghec-2022-11-28/apps.json index 8b4d81797c31..612c756daaf6 100644 --- a/src/rest/data/ghec-2022-11-28/apps.json +++ b/src/rest/data/ghec-2022-11-28/apps.json @@ -1830,7 +1830,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -2799,7 +2799,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3575,7 +3575,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -4220,7 +4220,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -5598,7 +5598,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -6381,7 +6381,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7740,7 +7740,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -8709,7 +8709,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -9688,7 +9688,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -10665,7 +10665,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -12640,7 +12640,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -17123,7 +17123,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -18074,7 +18074,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -18553,7 +18553,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -18655,7 +18655,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ diff --git a/src/rest/data/ghec-2022-11-28/copilot-spaces.json b/src/rest/data/ghec-2022-11-28/copilot-spaces.json new file mode 100644 index 000000000000..e26d08da25f6 --- /dev/null +++ b/src/rest/data/ghec-2022-11-28/copilot-spaces.json @@ -0,0 +1,9766 @@ +{ + "copilot-spaces": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces", + "title": "List organization Copilot Spaces", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.

", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.

", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.

\n

Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for listing organization copilot spaces

", + "example": { + "spaces": [ + { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3" + }, + { + "id": 85, + "number": 4, + "name": "Development Resources", + "description": "Shared development documentation and resources", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/4", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/4" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "spaces" + ], + "properties": { + "spaces": { + "type": "array", + "description": "The list of Copilot Spaces on this page of results.", + "items": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces", + "title": "Create an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "

The name of the Copilot Space.

", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

A description of the Copilot Space.

" + }, + { + "type": "string", + "name": "general_instructions", + "description": "

General instructions for the Copilot Space.

" + }, + { + "type": "string", + "name": "base_role", + "description": "

The base role that determines default permissions for organization members.

\n", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "default": "no_access" + }, + { + "type": "array of objects", + "name": "resources_attributes", + "description": "

Resources to attach to the space.

", + "childParamsGroups": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource.

", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Metadata specific to the resource type.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "repository_id", + "description": "

Repository ID for repository or file resources.

" + }, + { + "type": "string", + "name": "file_path", + "description": "

File path for file resources.

" + }, + { + "type": "string", + "name": "text", + "description": "

Text content for free text resources.

" + }, + { + "type": "string", + "name": "name", + "description": "

Name for the resource.

" + }, + { + "type": "integer", + "name": "number", + "description": "

Issue or PR number.

" + } + ] + } + ] + } + ], + "descriptionHTML": "

Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.

\n

Organization members with appropriate permissions can create Copilot Spaces to be shared within their organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/planning.md" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology and holds daily standups" + } + } + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Example response for an organization copilot space

", + "example": { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}", + "title": "Get an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.

\n

Internal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for an organization copilot space

", + "example": { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}", + "title": "Set an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "

The name of the Copilot Space.

" + }, + { + "type": "string", + "name": "description", + "description": "

A description of the Copilot Space.

" + }, + { + "type": "string", + "name": "general_instructions", + "description": "

General instructions for the Copilot Space.

" + }, + { + "type": "string", + "name": "base_role", + "description": "

The base role that determines default permissions for organization members. Changing this field requires admin permissions.

\n", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ] + }, + { + "type": "array of objects", + "name": "resources_attributes", + "description": "

Resources to attach to the space.

", + "childParamsGroups": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource.

", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Metadata specific to the resource type.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "repository_id", + "description": "

Repository ID for repository or file resources.

" + }, + { + "type": "string", + "name": "file_path", + "description": "

File path for file resources.

" + }, + { + "type": "string", + "name": "text", + "description": "

Text content for free text resources.

" + }, + { + "type": "string", + "name": "name", + "description": "

Name for the resource.

" + }, + { + "type": "integer", + "name": "number", + "description": "

Issue or PR number.

" + } + ] + } + ] + } + ], + "descriptionHTML": "

Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.

\n

Organization members with appropriate permissions can update Copilot Spaces owned by their organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Updated Team Planning Space", + "description": "Updated organization space for team planning and coordination", + "general_instructions": "Updated instructions to help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/updated-planning.md" + } + }, + { + "id": 789, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Team Guidelines", + "text": "Our updated team follows agile methodology and holds daily standups" + } + } + ] + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for an organization copilot space

", + "example": { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}", + "title": "Delete an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.

\n

Warning: This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.

\n

Organization members with appropriate permissions can delete Copilot Spaces owned by their organization.

\n

OAuth app tokens and personal access tokens (classic) need both the read:org and repo scopes to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "204", + "description": "

The Copilot Space has been successfully deleted.

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

The Copilot Space has been successfully deleted.

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces", + "title": "List Copilot Spaces for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.

", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.

", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces.

\n

Only Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for listing user copilot spaces

", + "example": { + "spaces": [ + { + "id": 42, + "number": 1, + "name": "Personal Research Space", + "description": "My personal space for research and development", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/1", + "api_url": "https://api.github.com/user/1/copilot-spaces/1" + }, + { + "id": 43, + "number": 2, + "name": "Learning Space", + "description": "Space for learning new technologies", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-17T08:20:00Z", + "updated_at": "2023-02-17T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/2", + "api_url": "https://api.github.com/user/1/copilot-spaces/2" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "spaces" + ], + "properties": { + "spaces": { + "type": "array", + "description": "The list of Copilot Spaces on this page of results.", + "items": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/users/{username}/copilot-spaces", + "title": "Create a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "

The name of the Copilot Space.

", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

A description of the Copilot Space.

" + }, + { + "type": "string", + "name": "general_instructions", + "description": "

General instructions for the Copilot Space.

" + }, + { + "type": "string", + "name": "base_role", + "description": "

The base role that determines default permissions for the space.

\n", + "enum": [ + "reader", + "no_access" + ], + "default": "no_access" + }, + { + "type": "array of objects", + "name": "resources_attributes", + "description": "

Resources to attach to the space.

", + "childParamsGroups": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource.

", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Metadata specific to the resource type.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "repository_id", + "description": "

Repository ID for repository or file resources.

" + }, + { + "type": "string", + "name": "file_path", + "description": "

File path for file resources.

" + }, + { + "type": "string", + "name": "text", + "description": "

Text content for free text resources.

" + }, + { + "type": "string", + "name": "name", + "description": "

Name for the resource.

" + }, + { + "type": "integer", + "name": "number", + "description": "

Issue or PR number.

" + } + ] + } + ] + } + ], + "descriptionHTML": "

Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account.

\n

Users can create personal Copilot Spaces for their individual use.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "My Development Space", + "description": "Personal space for development assistance", + "general_instructions": "Help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/App.js" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Development Notes", + "text": "Focus on clean code principles and modern React patterns" + } + } + ] + }, + "parameters": { + "username": "USERNAME" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Example response for a user copilot space

", + "example": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces/{space_number}", + "title": "Get a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space.

\n

Private user spaces require the authenticated user to be the owner of the space.\nPublic user spaces are accessible to any authenticated user.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for a user copilot space

", + "example": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/users/{username}/copilot-spaces/{space_number}", + "title": "Set a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "

The name of the Copilot Space.

" + }, + { + "type": "string", + "name": "description", + "description": "

A description of the Copilot Space.

" + }, + { + "type": "string", + "name": "general_instructions", + "description": "

General instructions for the Copilot Space.

" + }, + { + "type": "string", + "name": "base_role", + "description": "

The base role that determines default permissions for the space. Changing this field requires admin permissions.

\n", + "enum": [ + "reader", + "no_access" + ] + }, + { + "type": "array of objects", + "name": "resources_attributes", + "description": "

Resources to attach to the space.

", + "childParamsGroups": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource.

", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Metadata specific to the resource type.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "repository_id", + "description": "

Repository ID for repository or file resources.

" + }, + { + "type": "string", + "name": "file_path", + "description": "

File path for file resources.

" + }, + { + "type": "string", + "name": "text", + "description": "

Text content for free text resources.

" + }, + { + "type": "string", + "name": "name", + "description": "

Name for the resource.

" + }, + { + "type": "integer", + "name": "number", + "description": "

Issue or PR number.

" + } + ] + } + ] + } + ], + "descriptionHTML": "

Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account.

\n

Users can update their personal Copilot Spaces.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Updated Development Space", + "description": "Updated personal space for development assistance", + "general_instructions": "Updated instructions to help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/UpdatedApp.js" + } + }, + { + "id": 123, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Development Notes", + "text": "Updated focus on clean code principles and modern React patterns" + } + } + ] + }, + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for a user copilot space

", + "example": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/users/{username}/copilot-spaces/{space_number}", + "title": "Delete a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space.

\n

Warning: This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "204", + "description": "

The Copilot Space has been successfully deleted.

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

The Copilot Space has been successfully deleted.

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + } + ], + "collaborators": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "title": "List collaborators for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.

\n

Each collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.

\n

Note: Team collaborators listed here are teams that are defined in the organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "collaborators": [ + { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + } + ] + }, + "schema": { + "type": "object", + "required": [ + "collaborators" + ], + "properties": { + "collaborators": { + "type": "array", + "description": "The list of collaborators for this Copilot Space.", + "items": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "title": "Add a collaborator to an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "actor_type", + "description": "

The type of actor (user or team).

", + "isRequired": true, + "enum": [ + "User", + "Team" + ] + }, + { + "type": "string", + "name": "actor_identifier", + "description": "

The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.

", + "isRequired": true + }, + { + "type": "string", + "name": "role", + "description": "

The role to grant to the collaborator.

", + "isRequired": true, + "enum": [ + "reader", + "writer", + "admin" + ] + } + ], + "descriptionHTML": "

Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.

\n

Note: When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example 1: Status Code 201", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + }, + { + "request": { + "contentType": "application/json", + "description": "Example 2: Status Code 201", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "actor_type": "Team", + "actor_identifier": "developers", + "role": "reader" + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "title": "Set a collaborator role for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "

The type of actor (user or team).

", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "

The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "role", + "description": "

The new role to grant to the collaborator. Use no_access to remove the collaborator.

", + "isRequired": true, + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ] + } + ], + "descriptionHTML": "

Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example 1: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "role": "admin" + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + }, + { + "request": { + "contentType": "application/json", + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "role": "admin" + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "Team", + "role": "admin", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "204", + "description": "

Response when role is no_access and the collaborator was removed.

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "title": "Remove a collaborator from an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "

The type of actor (user or team).

", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "

The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/collaborators", + "title": "List collaborators for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

\n

Each collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list.

\n

Team collaborators are not supported for user-owned Copilot Spaces.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "collaborators": [ + { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "User", + "role": "reader", + "login": "github-user", + "id": 67890, + "node_id": "MDQ6VXNlcjY3ODkw", + "avatar_url": "https://github.com/images/error/other_user.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github-user", + "html_url": "https://github.com/github-user", + "followers_url": "https://api.github.com/users/github-user/followers", + "following_url": "https://api.github.com/users/github-user/following{/other_user}", + "gists_url": "https://api.github.com/users/github-user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github-user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github-user/subscriptions", + "organizations_url": "https://api.github.com/users/github-user/orgs", + "repos_url": "https://api.github.com/users/github-user/repos", + "events_url": "https://api.github.com/users/github-user/events{/privacy}", + "received_events_url": "https://api.github.com/users/github-user/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "GitHub User", + "company": null, + "blog": "", + "location": null, + "email": null, + "hireable": null, + "bio": null, + "twitter_username": null, + "public_repos": 5, + "public_gists": 0, + "followers": 10, + "following": 5, + "created_at": "2010-01-14T04:33:35Z", + "updated_at": "2010-01-14T04:33:35Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "collaborators" + ], + "properties": { + "collaborators": { + "type": "array", + "description": "The list of collaborators for this Copilot Space.", + "items": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/collaborators", + "title": "Add a collaborator to a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "actor_type", + "description": "

The type of actor (must be User for user-owned spaces; Team will be rejected).

", + "isRequired": true, + "enum": [ + "User", + "Team" + ] + }, + { + "type": "string", + "name": "actor_identifier", + "description": "

The username of the collaborator. The numeric user ID is also accepted.

", + "isRequired": true + }, + { + "type": "string", + "name": "role", + "description": "

The role to grant to the collaborator.

", + "isRequired": true, + "enum": [ + "reader", + "writer", + "admin" + ] + } + ], + "descriptionHTML": "

Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

\n

Team collaborators are not supported for user-owned Copilot Spaces.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" + }, + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "title": "Set a collaborator role for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "

The type of actor (must be User for user-owned spaces; Team will be rejected).

", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "

The username of the collaborator. The numeric user ID is also accepted.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "role", + "description": "

The new role to grant to the collaborator. Use no_access to remove the collaborator.

", + "isRequired": true, + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ] + } + ], + "descriptionHTML": "

Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "role": "admin" + }, + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "204", + "description": "

Response when role is no_access and the collaborator was removed.

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "title": "Remove a collaborator from a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "

The type of actor (must be User for user-owned spaces; Team will be rejected).

", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "

The username of the collaborator. The numeric user ID is also accepted.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + } + ], + "resources": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources", + "title": "List resources for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "resources": [ + { + "id": 1, + "resource_type": "repository", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42 + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + { + "id": 2, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources", + "title": "Create a resource for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource to create.

", + "isRequired": true, + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Resource-specific metadata.

", + "isRequired": true + } + ], + "descriptionHTML": "

Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.

\n

The following resource types are supported: repository, github_file, free_text, github_issue, github_pull_request.\nThe uploaded_text_file and media_content types are not supported via this endpoint.

\n

For github_file resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a 200 status.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Duplicate github_file resource already exists

" + }, + { + "httpStatusCode": "201", + "description": "

Resource created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Get a resource for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Set a resource for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "object", + "name": "metadata", + "description": "

Updated resource-specific metadata.

" + } + ], + "descriptionHTML": "

Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" + }, + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Delete a resource from an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources", + "title": "List resources for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists all resources attached to a specific Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "resources": [ + { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources", + "title": "Create a resource for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource to create.

", + "isRequired": true, + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Resource-specific metadata.

", + "isRequired": true + } + ], + "descriptionHTML": "

Creates a new resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.

\n

The following resource types are supported: repository, github_file, free_text, github_issue, github_pull_request.\nThe uploaded_text_file and media_content types are not supported via this endpoint.

\n

For github_file resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a 200 status.

\n

OAuth app tokens and personal access tokens (classic) need the write:user scope to use this endpoint.

", + "codeExamples": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Duplicate github_file resource already exists

" + }, + { + "httpStatusCode": "201", + "description": "

Resource created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Get a resource for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Gets a specific resource attached to a Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Set a resource for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "object", + "name": "metadata", + "description": "

Updated resource-specific metadata.

" + } + ], + "descriptionHTML": "

Updates the metadata of a resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.

\n

OAuth app tokens and personal access tokens (classic) need the write:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + }, + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" + }, + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Delete a resource from a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes a resource from a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.

\n

OAuth app tokens and personal access tokens (classic) need the write:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + } + ] +} \ No newline at end of file diff --git a/src/rest/data/ghec-2022-11-28/copilot.json b/src/rest/data/ghec-2022-11-28/copilot.json index 8c52e2c72b85..9052267f9e7e 100644 --- a/src/rest/data/ghec-2022-11-28/copilot.json +++ b/src/rest/data/ghec-2022-11-28/copilot.json @@ -22,7 +22,7 @@ { "type": "string", "name": "policy_state", - "description": "

The policy state for Copilot coding agent in the enterprise. Can be one of enabled_for_all_orgs, disabled_for_all_orgs, enabled_for_selected_orgs, or configured_by_org_admins.

", + "description": "

The policy state for Copilot cloud agent in the enterprise. Can be one of enabled_for_all_orgs, disabled_for_all_orgs, enabled_for_selected_orgs, or configured_by_org_admins.

", "isRequired": true, "enum": [ "enabled_for_all_orgs", @@ -32,7 +32,7 @@ ] } ], - "descriptionHTML": "

Sets the policy for Copilot coding agent usage across an enterprise.

\n

Enterprise owners can configure whether Copilot coding agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.

\n

Only enterprise owners can set the coding agent policy for their enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Sets the policy for Copilot cloud agent usage across an enterprise.

\n

Enterprise owners can configure whether Copilot cloud agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.

\n

Only enterprise owners can set the coding agent policy for their enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -92,7 +92,7 @@ { "type": "array of strings", "name": "organizations", - "description": "

List of organization logins within the enterprise to enable Copilot coding agent for.

" + "description": "

List of organization logins within the enterprise to enable Copilot cloud agent for.

" }, { "type": "array of objects", @@ -114,7 +114,7 @@ ] } ], - "descriptionHTML": "

Enables Copilot coding agent for the specified organizations within the enterprise.

\n

The enterprise's coding agent policy must be set to enabled_for_selected_orgs before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.

\n

Only organizations that have Copilot enabled and belong to the enterprise will be affected.

\n

Only enterprise owners can add organizations to the coding agent policy.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Enables Copilot cloud agent for the specified organizations within the enterprise.

\n

The enterprise's coding agent policy must be set to enabled_for_selected_orgs before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.

\n

Only organizations that have Copilot enabled and belong to the enterprise will be affected.

\n

Only enterprise owners can add organizations to the coding agent policy.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -186,7 +186,7 @@ { "type": "array of strings", "name": "organizations", - "description": "

List of organization logins within the enterprise to disable Copilot coding agent for.

" + "description": "

List of organization logins within the enterprise to disable Copilot cloud agent for.

" }, { "type": "array of objects", @@ -208,7 +208,7 @@ ] } ], - "descriptionHTML": "

Disables Copilot coding agent for the specified organizations within the enterprise.

\n

The enterprise's coding agent policy must be set to enabled_for_selected_orgs before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.

\n

Only organizations that have Copilot enabled and belong to the enterprise will be affected.

\n

Only enterprise owners can remove organizations from the coding agent policy.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Disables Copilot cloud agent for the specified organizations within the enterprise.

\n

The enterprise's coding agent policy must be set to enabled_for_selected_orgs before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.

\n

Only organizations that have Copilot enabled and belong to the enterprise will be affected.

\n

Only enterprise owners can remove organizations from the coding agent policy.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -262,7 +262,7 @@ "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", - "title": "Get Copilot coding agent permissions for an organization", + "title": "Get Copilot cloud agent permissions for an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -277,7 +277,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about which repositories in an organization have been enabled\nor disabled for the Copilot coding agent.

\n

Organization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about which repositories in an organization have been enabled\nor disabled for the Copilot cloud agent.

\n

Organization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -299,7 +299,7 @@ "properties": { "enabled_repositories": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", "selected", @@ -338,7 +338,7 @@ "properties": { "enabled_repositories": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", "selected", @@ -376,7 +376,7 @@ "properties": { "enabled_repositories": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", "selected", @@ -433,7 +433,7 @@ "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", - "title": "Set Copilot coding agent permissions for an organization", + "title": "Set Copilot cloud agent permissions for an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -451,7 +451,7 @@ { "type": "string", "name": "enabled_repositories", - "description": "

The policy for which repositories can use Copilot coding agent. Can be one of all, selected, or none.

", + "description": "

The policy for which repositories can use Copilot cloud agent. Can be one of all, selected, or none.

", "isRequired": true, "enum": [ "all", @@ -460,7 +460,7 @@ ] } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets the policy for which repositories in an organization can use Copilot coding agent.

\n

Organization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets the policy for which repositories in an organization can use Copilot cloud agent.

\n

Organization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -522,7 +522,7 @@ "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", - "title": "List repositories enabled for Copilot coding agent in an organization", + "title": "List repositories enabled for Copilot cloud agent in an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -555,7 +555,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists the selected repositories that are enabled for Copilot coding agent in an organization.

\n

Organization owners can use this endpoint when the coding agent repository policy\nis set to selected to see which repositories have been enabled.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists the selected repositories that are enabled for Copilot cloud agent in an organization.

\n

Organization owners can use this endpoint when the coding agent repository policy\nis set to selected to see which repositories have been enabled.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -1596,7 +1596,7 @@ "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", - "title": "Set selected repositories for Copilot coding agent in an organization", + "title": "Set selected repositories for Copilot cloud agent in an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -1614,11 +1614,11 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

List of repository IDs to enable for Copilot coding agent.

", + "description": "

List of repository IDs to enable for Copilot cloud agent.

", "isRequired": true } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Replaces the list of selected repositories that are enabled for Copilot coding\nagent in an organization. This method can only be called when the coding agent\nrepository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Replaces the list of selected repositories that are enabled for Copilot cloud\nagent in an organization. This method can only be called when the cloud agent\nrepository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -1687,7 +1687,7 @@ "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", - "title": "Enable a repository for Copilot coding agent in an organization", + "title": "Enable a repository for Copilot cloud agent in an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -1711,7 +1711,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Adds a repository to the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Adds a repository to the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -1775,7 +1775,7 @@ "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", - "title": "Disable a repository for Copilot coding agent in an organization", + "title": "Disable a repository for Copilot cloud agent in an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -1799,7 +1799,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Removes a repository from the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Removes a repository from the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scopes to use this endpoint.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/enterprise-admin.json b/src/rest/data/ghec-2022-11-28/enterprise-admin.json index 5144cf5353b0..de91480fd5eb 100644 --- a/src/rest/data/ghec-2022-11-28/enterprise-admin.json +++ b/src/rest/data/ghec-2022-11-28/enterprise-admin.json @@ -8837,7 +8837,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -9690,7 +9690,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -10928,7 +10928,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -11636,7 +11636,7 @@ { "type": "integer or null", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.

" + "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin, EnterpriseOwner and EnterpriseRole are not applicable for personal repositories.

" }, { "type": "string", @@ -11649,7 +11649,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ] }, { @@ -13201,7 +13202,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -13211,7 +13212,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -14377,7 +14379,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -14387,7 +14389,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -14633,7 +14635,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -14643,7 +14645,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -15809,7 +15812,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -15819,7 +15822,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -15981,7 +15984,7 @@ { "type": "integer or null", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.

" + "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin, EnterpriseOwner and EnterpriseRole are not applicable for personal repositories.

" }, { "type": "string", @@ -15994,7 +15997,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ] }, { @@ -17547,7 +17551,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -17557,7 +17561,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -18723,7 +18728,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -18733,7 +18738,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", diff --git a/src/rest/data/ghec-2022-11-28/orgs.json b/src/rest/data/ghec-2022-11-28/orgs.json index a63de71cf7fd..44ec1db1690c 100644 --- a/src/rest/data/ghec-2022-11-28/orgs.json +++ b/src/rest/data/ghec-2022-11-28/orgs.json @@ -489,32 +489,32 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { @@ -530,7 +530,7 @@ }, "secret_scanning_validity_checks_enabled": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "deprecated": true }, "created_at": { @@ -1134,32 +1134,32 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { @@ -1175,7 +1175,7 @@ }, "secret_scanning_validity_checks_enabled": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "deprecated": true }, "created_at": { @@ -2522,7 +2522,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -25795,7 +25795,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -25805,7 +25805,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -26971,7 +26972,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -26981,7 +26982,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -27137,7 +27138,7 @@ { "type": "integer or null", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.

" + "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin, EnterpriseOwner and EnterpriseRole are not applicable for personal repositories.

" }, { "type": "string", @@ -27150,7 +27151,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ] }, { @@ -28350,7 +28352,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -28360,7 +28362,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -29526,7 +29529,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -29536,7 +29539,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -29805,7 +29808,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -29815,7 +29818,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -30981,7 +30985,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -30991,7 +30995,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -31152,7 +31156,7 @@ { "type": "integer or null", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.

" + "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin, EnterpriseOwner and EnterpriseRole are not applicable for personal repositories.

" }, { "type": "string", @@ -31165,7 +31169,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ] }, { @@ -32366,7 +32371,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -32376,7 +32381,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -33542,7 +33548,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -33552,7 +33558,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -35268,7 +35274,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -35397,7 +35403,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ diff --git a/src/rest/data/ghec-2022-11-28/repos.json b/src/rest/data/ghec-2022-11-28/repos.json index 74101e3fba14..be111dd657c9 100644 --- a/src/rest/data/ghec-2022-11-28/repos.json +++ b/src/rest/data/ghec-2022-11-28/repos.json @@ -38195,7 +38195,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -38205,7 +38205,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -38527,7 +38527,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -38537,7 +38537,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -39703,7 +39704,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -39713,7 +39714,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -39878,7 +39879,7 @@ { "type": "integer or null", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.

" + "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin, EnterpriseOwner and EnterpriseRole are not applicable for personal repositories.

" }, { "type": "string", @@ -39891,7 +39892,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ] }, { @@ -40990,7 +40992,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -41000,7 +41002,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -42166,7 +42169,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -42176,7 +42179,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -42455,7 +42458,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -42465,7 +42468,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -43631,7 +43635,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -43641,7 +43645,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -43811,7 +43815,7 @@ { "type": "integer or null", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.

" + "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin, EnterpriseOwner and EnterpriseRole are not applicable for personal repositories.

" }, { "type": "string", @@ -43824,7 +43828,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ] }, { @@ -44924,7 +44929,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -44934,7 +44939,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -46100,7 +46106,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -46110,7 +46116,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -46774,7 +46780,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -47057,7 +47063,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -47296,7 +47302,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -47586,7 +47592,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -47851,7 +47857,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -47988,7 +47994,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ diff --git a/src/rest/data/ghec-2022-11-28/secret-scanning.json b/src/rest/data/ghec-2022-11-28/secret-scanning.json index 926e59e67356..b0fb3cfa896c 100644 --- a/src/rest/data/ghec-2022-11-28/secret-scanning.json +++ b/src/rest/data/ghec-2022-11-28/secret-scanning.json @@ -578,7 +578,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -2459,7 +2459,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -4294,7 +4294,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -5515,7 +5515,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -6513,6 +6513,16 @@ "type": "string or null", "name": "assignee", "description": "

The username of the user to assign to the alert. Set to null to unassign the alert.

" + }, + { + "type": "string or null", + "name": "validity", + "description": "

Sets the validity of the secret scanning alert. Can be active, inactive, or null to clear the override.

", + "enum": [ + "active", + "inactive", + null + ] } ], "descriptionHTML": "

Updates the status of a secret scanning alert in an eligible repository.

\n

You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.

\n

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

", @@ -6805,7 +6815,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -7719,7 +7729,7 @@ }, { "httpStatusCode": "422", - "description": "

State does not match the resolution or resolution comment, or assignee does not have write access to the repository

" + "description": "

State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert

" }, { "httpStatusCode": "503", diff --git a/src/rest/data/ghec-2026-03-10/actions.json b/src/rest/data/ghec-2026-03-10/actions.json index 55d09ed4254d..03b1abf38051 100644 --- a/src/rest/data/ghec-2026-03-10/actions.json +++ b/src/rest/data/ghec-2026-03-10/actions.json @@ -8347,6 +8347,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } }, "required": [ @@ -8397,6 +8401,11 @@ "type": "array of strings", "name": "include_claim_keys", "description": "

Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.

" + }, + { + "type": "boolean", + "name": "use_immutable_subject", + "description": "

Whether to opt in to the immutable OIDC subject claim format for the organization. When true, new OIDC tokens will use a stable, repository-ID-based sub claim instead of the name-based format.

" } ], "descriptionHTML": "

Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", @@ -8522,6 +8531,14 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether the repository has opted in to the immutable OIDC subject claim format. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim. If not set at the repository level, falls back to the organization-level setting.", + "type": "boolean" + }, + "sub_claim_prefix": { + "description": "The current `sub` claim prefix for this repository.", + "type": "string" } }, "required": [ @@ -8596,6 +8613,11 @@ "type": "array of strings", "name": "include_claim_keys", "description": "

Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.

" + }, + { + "type": "boolean", + "name": "use_immutable_subject", + "description": "

Whether to opt in to the immutable OIDC subject claim format for this repository. When true, OIDC tokens will use a stable, repository-ID-based sub claim.

" } ], "descriptionHTML": "

Sets the customization template and opt-in or opt-out flag for an OpenID Connect (OIDC) subject claim for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", @@ -48255,7 +48277,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response including the workflow run ID and URLs when return_run_details parameter is true.

", + "description": "

Response including the workflow run ID and URLs.

", "example": { "workflow_run_id": 1, "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1", @@ -48294,7 +48316,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

Response including the workflow run ID and URLs when return_run_details parameter is true.

" + "description": "

Response including the workflow run ID and URLs.

" } ], "previews": [], diff --git a/src/rest/data/ghec-2026-03-10/announcement-banners.json b/src/rest/data/ghec-2026-03-10/announcement-banners.json index 4dca133fde21..3cc624155a9a 100644 --- a/src/rest/data/ghec-2026-03-10/announcement-banners.json +++ b/src/rest/data/ghec-2026-03-10/announcement-banners.json @@ -48,7 +48,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" }, "expires_at": { "type": [ @@ -162,7 +162,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" }, "expires_at": { "type": [ @@ -303,7 +303,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" }, "expires_at": { "type": [ @@ -421,7 +421,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" }, "expires_at": { "type": [ diff --git a/src/rest/data/ghec-2026-03-10/apps.json b/src/rest/data/ghec-2026-03-10/apps.json index 68f6176912d1..2e3b1f3c5d6c 100644 --- a/src/rest/data/ghec-2026-03-10/apps.json +++ b/src/rest/data/ghec-2026-03-10/apps.json @@ -1830,7 +1830,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -2799,7 +2799,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3575,7 +3575,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -4220,7 +4220,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -5582,7 +5582,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -6365,7 +6365,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7724,7 +7724,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -8693,7 +8693,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -9672,7 +9672,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -10649,7 +10649,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -12608,7 +12608,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -17075,7 +17075,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -18026,7 +18026,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -18505,7 +18505,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -18607,7 +18607,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ diff --git a/src/rest/data/ghec-2026-03-10/copilot-spaces.json b/src/rest/data/ghec-2026-03-10/copilot-spaces.json new file mode 100644 index 000000000000..e26d08da25f6 --- /dev/null +++ b/src/rest/data/ghec-2026-03-10/copilot-spaces.json @@ -0,0 +1,9766 @@ +{ + "copilot-spaces": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces", + "title": "List organization Copilot Spaces", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.

", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.

", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.

\n

Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for listing organization copilot spaces

", + "example": { + "spaces": [ + { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3" + }, + { + "id": 85, + "number": 4, + "name": "Development Resources", + "description": "Shared development documentation and resources", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/4", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/4" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "spaces" + ], + "properties": { + "spaces": { + "type": "array", + "description": "The list of Copilot Spaces on this page of results.", + "items": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces", + "title": "Create an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "

The name of the Copilot Space.

", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

A description of the Copilot Space.

" + }, + { + "type": "string", + "name": "general_instructions", + "description": "

General instructions for the Copilot Space.

" + }, + { + "type": "string", + "name": "base_role", + "description": "

The base role that determines default permissions for organization members.

\n", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "default": "no_access" + }, + { + "type": "array of objects", + "name": "resources_attributes", + "description": "

Resources to attach to the space.

", + "childParamsGroups": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource.

", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Metadata specific to the resource type.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "repository_id", + "description": "

Repository ID for repository or file resources.

" + }, + { + "type": "string", + "name": "file_path", + "description": "

File path for file resources.

" + }, + { + "type": "string", + "name": "text", + "description": "

Text content for free text resources.

" + }, + { + "type": "string", + "name": "name", + "description": "

Name for the resource.

" + }, + { + "type": "integer", + "name": "number", + "description": "

Issue or PR number.

" + } + ] + } + ] + } + ], + "descriptionHTML": "

Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.

\n

Organization members with appropriate permissions can create Copilot Spaces to be shared within their organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/planning.md" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology and holds daily standups" + } + } + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Example response for an organization copilot space

", + "example": { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}", + "title": "Get an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.

\n

Internal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for an organization copilot space

", + "example": { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}", + "title": "Set an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "

The name of the Copilot Space.

" + }, + { + "type": "string", + "name": "description", + "description": "

A description of the Copilot Space.

" + }, + { + "type": "string", + "name": "general_instructions", + "description": "

General instructions for the Copilot Space.

" + }, + { + "type": "string", + "name": "base_role", + "description": "

The base role that determines default permissions for organization members. Changing this field requires admin permissions.

\n", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ] + }, + { + "type": "array of objects", + "name": "resources_attributes", + "description": "

Resources to attach to the space.

", + "childParamsGroups": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource.

", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Metadata specific to the resource type.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "repository_id", + "description": "

Repository ID for repository or file resources.

" + }, + { + "type": "string", + "name": "file_path", + "description": "

File path for file resources.

" + }, + { + "type": "string", + "name": "text", + "description": "

Text content for free text resources.

" + }, + { + "type": "string", + "name": "name", + "description": "

Name for the resource.

" + }, + { + "type": "integer", + "name": "number", + "description": "

Issue or PR number.

" + } + ] + } + ] + } + ], + "descriptionHTML": "

Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.

\n

Organization members with appropriate permissions can update Copilot Spaces owned by their organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Updated Team Planning Space", + "description": "Updated organization space for team planning and coordination", + "general_instructions": "Updated instructions to help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/updated-planning.md" + } + }, + { + "id": 789, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Team Guidelines", + "text": "Our updated team follows agile methodology and holds daily standups" + } + } + ] + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for an organization copilot space

", + "example": { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}", + "title": "Delete an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.

\n

Warning: This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.

\n

Organization members with appropriate permissions can delete Copilot Spaces owned by their organization.

\n

OAuth app tokens and personal access tokens (classic) need both the read:org and repo scopes to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "204", + "description": "

The Copilot Space has been successfully deleted.

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

The Copilot Space has been successfully deleted.

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces", + "title": "List Copilot Spaces for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.

", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.

", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces.

\n

Only Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for listing user copilot spaces

", + "example": { + "spaces": [ + { + "id": 42, + "number": 1, + "name": "Personal Research Space", + "description": "My personal space for research and development", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/1", + "api_url": "https://api.github.com/user/1/copilot-spaces/1" + }, + { + "id": 43, + "number": 2, + "name": "Learning Space", + "description": "Space for learning new technologies", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-17T08:20:00Z", + "updated_at": "2023-02-17T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/2", + "api_url": "https://api.github.com/user/1/copilot-spaces/2" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "spaces" + ], + "properties": { + "spaces": { + "type": "array", + "description": "The list of Copilot Spaces on this page of results.", + "items": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/users/{username}/copilot-spaces", + "title": "Create a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "

The name of the Copilot Space.

", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

A description of the Copilot Space.

" + }, + { + "type": "string", + "name": "general_instructions", + "description": "

General instructions for the Copilot Space.

" + }, + { + "type": "string", + "name": "base_role", + "description": "

The base role that determines default permissions for the space.

\n", + "enum": [ + "reader", + "no_access" + ], + "default": "no_access" + }, + { + "type": "array of objects", + "name": "resources_attributes", + "description": "

Resources to attach to the space.

", + "childParamsGroups": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource.

", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Metadata specific to the resource type.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "repository_id", + "description": "

Repository ID for repository or file resources.

" + }, + { + "type": "string", + "name": "file_path", + "description": "

File path for file resources.

" + }, + { + "type": "string", + "name": "text", + "description": "

Text content for free text resources.

" + }, + { + "type": "string", + "name": "name", + "description": "

Name for the resource.

" + }, + { + "type": "integer", + "name": "number", + "description": "

Issue or PR number.

" + } + ] + } + ] + } + ], + "descriptionHTML": "

Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account.

\n

Users can create personal Copilot Spaces for their individual use.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "My Development Space", + "description": "Personal space for development assistance", + "general_instructions": "Help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/App.js" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Development Notes", + "text": "Focus on clean code principles and modern React patterns" + } + } + ] + }, + "parameters": { + "username": "USERNAME" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Example response for a user copilot space

", + "example": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces/{space_number}", + "title": "Get a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space.

\n

Private user spaces require the authenticated user to be the owner of the space.\nPublic user spaces are accessible to any authenticated user.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for a user copilot space

", + "example": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/users/{username}/copilot-spaces/{space_number}", + "title": "Set a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "

The name of the Copilot Space.

" + }, + { + "type": "string", + "name": "description", + "description": "

A description of the Copilot Space.

" + }, + { + "type": "string", + "name": "general_instructions", + "description": "

General instructions for the Copilot Space.

" + }, + { + "type": "string", + "name": "base_role", + "description": "

The base role that determines default permissions for the space. Changing this field requires admin permissions.

\n", + "enum": [ + "reader", + "no_access" + ] + }, + { + "type": "array of objects", + "name": "resources_attributes", + "description": "

Resources to attach to the space.

", + "childParamsGroups": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource.

", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Metadata specific to the resource type.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "repository_id", + "description": "

Repository ID for repository or file resources.

" + }, + { + "type": "string", + "name": "file_path", + "description": "

File path for file resources.

" + }, + { + "type": "string", + "name": "text", + "description": "

Text content for free text resources.

" + }, + { + "type": "string", + "name": "name", + "description": "

Name for the resource.

" + }, + { + "type": "integer", + "name": "number", + "description": "

Issue or PR number.

" + } + ] + } + ] + } + ], + "descriptionHTML": "

Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account.

\n

Users can update their personal Copilot Spaces.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Updated Development Space", + "description": "Updated personal space for development assistance", + "general_instructions": "Updated instructions to help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/UpdatedApp.js" + } + }, + { + "id": 123, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Development Notes", + "text": "Updated focus on clean code principles and modern React patterns" + } + } + ] + }, + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Example response for a user copilot space

", + "example": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + }, + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space." + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner." + }, + "name": { + "type": "string", + "description": "The display name of the space." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space." + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space." + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)" + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space." + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space." + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/users/{username}/copilot-spaces/{space_number}", + "title": "Delete a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "copilot-spaces", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space.

\n

Warning: This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "204", + "description": "

The Copilot Space has been successfully deleted.

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

The Copilot Space has been successfully deleted.

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + } + ], + "collaborators": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "title": "List collaborators for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.

\n

Each collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.

\n

Note: Team collaborators listed here are teams that are defined in the organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "collaborators": [ + { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + } + ] + }, + "schema": { + "type": "object", + "required": [ + "collaborators" + ], + "properties": { + "collaborators": { + "type": "array", + "description": "The list of collaborators for this Copilot Space.", + "items": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators", + "title": "Add a collaborator to an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "actor_type", + "description": "

The type of actor (user or team).

", + "isRequired": true, + "enum": [ + "User", + "Team" + ] + }, + { + "type": "string", + "name": "actor_identifier", + "description": "

The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.

", + "isRequired": true + }, + { + "type": "string", + "name": "role", + "description": "

The role to grant to the collaborator.

", + "isRequired": true, + "enum": [ + "reader", + "writer", + "admin" + ] + } + ], + "descriptionHTML": "

Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.

\n

Note: When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example 1: Status Code 201", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + }, + { + "request": { + "contentType": "application/json", + "description": "Example 2: Status Code 201", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "actor_type": "Team", + "actor_identifier": "developers", + "role": "reader" + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "title": "Set a collaborator role for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "

The type of actor (user or team).

", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "

The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "role", + "description": "

The new role to grant to the collaborator. Use no_access to remove the collaborator.

", + "isRequired": true, + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ] + } + ], + "descriptionHTML": "

Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example 1: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "role": "admin" + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + }, + { + "request": { + "contentType": "application/json", + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "role": "admin" + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "Team", + "role": "admin", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "204", + "description": "

Response when role is no_access and the collaborator was removed.

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "title": "Remove a collaborator from an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "

The type of actor (user or team).

", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "

The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/collaborators", + "title": "List collaborators for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

\n

Each collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list.

\n

Team collaborators are not supported for user-owned Copilot Spaces.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "collaborators": [ + { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "User", + "role": "reader", + "login": "github-user", + "id": 67890, + "node_id": "MDQ6VXNlcjY3ODkw", + "avatar_url": "https://github.com/images/error/other_user.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github-user", + "html_url": "https://github.com/github-user", + "followers_url": "https://api.github.com/users/github-user/followers", + "following_url": "https://api.github.com/users/github-user/following{/other_user}", + "gists_url": "https://api.github.com/users/github-user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github-user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github-user/subscriptions", + "organizations_url": "https://api.github.com/users/github-user/orgs", + "repos_url": "https://api.github.com/users/github-user/repos", + "events_url": "https://api.github.com/users/github-user/events{/privacy}", + "received_events_url": "https://api.github.com/users/github-user/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "GitHub User", + "company": null, + "blog": "", + "location": null, + "email": null, + "hireable": null, + "bio": null, + "twitter_username": null, + "public_repos": 5, + "public_gists": 0, + "followers": 10, + "following": 5, + "created_at": "2010-01-14T04:33:35Z", + "updated_at": "2010-01-14T04:33:35Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "collaborators" + ], + "properties": { + "collaborators": { + "type": "array", + "description": "The list of collaborators for this Copilot Space.", + "items": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/collaborators", + "title": "Add a collaborator to a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "actor_type", + "description": "

The type of actor (must be User for user-owned spaces; Team will be rejected).

", + "isRequired": true, + "enum": [ + "User", + "Team" + ] + }, + { + "type": "string", + "name": "actor_identifier", + "description": "

The username of the collaborator. The numeric user ID is also accepted.

", + "isRequired": true + }, + { + "type": "string", + "name": "role", + "description": "

The role to grant to the collaborator.

", + "isRequired": true, + "enum": [ + "reader", + "writer", + "admin" + ] + } + ], + "descriptionHTML": "

Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

\n

Team collaborators are not supported for user-owned Copilot Spaces.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" + }, + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "title": "Set a collaborator role for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "

The type of actor (must be User for user-owned spaces; Team will be rejected).

", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "

The username of the collaborator. The numeric user ID is also accepted.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "role", + "description": "

The new role to grant to the collaborator. Use no_access to remove the collaborator.

", + "isRequired": true, + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ] + } + ], + "descriptionHTML": "

Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "role": "admin" + }, + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "204", + "description": "

Response when role is no_access and the collaborator was removed.

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}", + "title": "Remove a collaborator from a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "collaborators", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "

The type of actor (must be User for user-owned spaces; Team will be rejected).

", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "

The username of the collaborator. The numeric user ID is also accepted.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "actor_type": "ACTOR_TYPE", + "actor_identifier": "ACTOR_IDENTIFIER" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + } + ], + "resources": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources", + "title": "List resources for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "resources": [ + { + "id": 1, + "resource_type": "repository", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42 + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + { + "id": 2, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources", + "title": "Create a resource for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource to create.

", + "isRequired": true, + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Resource-specific metadata.

", + "isRequired": true + } + ], + "descriptionHTML": "

Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.

\n

The following resource types are supported: repository, github_file, free_text, github_issue, github_pull_request.\nThe uploaded_text_file and media_content types are not supported via this endpoint.

\n

For github_file resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a 200 status.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Duplicate github_file resource already exists

" + }, + { + "httpStatusCode": "201", + "description": "

Resource created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Get a resource for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Set a resource for an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "object", + "name": "metadata", + "description": "

Updated resource-specific metadata.

" + } + ], + "descriptionHTML": "

Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + }, + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" + }, + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Delete a resource from an organization Copilot Space", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot Spaces\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources", + "title": "List resources for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists all resources attached to a specific Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "resources": [ + { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources", + "title": "Create a resource for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "resource_type", + "description": "

The type of resource to create.

", + "isRequired": true, + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ] + }, + { + "type": "object", + "name": "metadata", + "description": "

Resource-specific metadata.

", + "isRequired": true + } + ], + "descriptionHTML": "

Creates a new resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.

\n

The following resource types are supported: repository, github_file, free_text, github_issue, github_pull_request.\nThe uploaded_text_file and media_content types are not supported via this endpoint.

\n

For github_file resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a 200 status.

\n

OAuth app tokens and personal access tokens (classic) need the write:user scope to use this endpoint.

", + "codeExamples": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Duplicate github_file resource already exists

" + }, + { + "httpStatusCode": "201", + "description": "

Resource created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Get a resource for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Gets a specific resource attached to a Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.

\n

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Set a resource for a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "object", + "name": "metadata", + "description": "

Updated resource-specific metadata.

" + } + ], + "descriptionHTML": "

Updates the metadata of a resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.

\n

OAuth app tokens and personal access tokens (classic) need the write:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + }, + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" + }, + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}", + "title": "Delete a resource from a Copilot Space for a user", + "category": "copilot-spaces", + "subcategory": "resources", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "

The unique identifier of the Copilot Space.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "

The unique identifier of the resource.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes a resource from a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.

\n

OAuth app tokens and personal access tokens (classic) need the write:user scope to use this endpoint.

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME", + "space_number": "SPACE_NUMBER", + "space_resource_id": "SPACE_RESOURCE_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + } + ] +} \ No newline at end of file diff --git a/src/rest/data/ghec-2026-03-10/copilot.json b/src/rest/data/ghec-2026-03-10/copilot.json index 0683ef2ed3e2..9bb1fc230c75 100644 --- a/src/rest/data/ghec-2026-03-10/copilot.json +++ b/src/rest/data/ghec-2026-03-10/copilot.json @@ -22,7 +22,7 @@ { "type": "string", "name": "policy_state", - "description": "

The policy state for Copilot coding agent in the enterprise. Can be one of enabled_for_all_orgs, disabled_for_all_orgs, enabled_for_selected_orgs, or configured_by_org_admins.

", + "description": "

The policy state for Copilot cloud agent in the enterprise. Can be one of enabled_for_all_orgs, disabled_for_all_orgs, enabled_for_selected_orgs, or configured_by_org_admins.

", "isRequired": true, "enum": [ "enabled_for_all_orgs", @@ -32,7 +32,7 @@ ] } ], - "descriptionHTML": "

Sets the policy for Copilot coding agent usage across an enterprise.

\n

Enterprise owners can configure whether Copilot coding agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.

\n

Only enterprise owners can set the coding agent policy for their enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Sets the policy for Copilot cloud agent usage across an enterprise.

\n

Enterprise owners can configure whether Copilot cloud agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.

\n

Only enterprise owners can set the coding agent policy for their enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -92,7 +92,7 @@ { "type": "array of strings", "name": "organizations", - "description": "

List of organization logins within the enterprise to enable Copilot coding agent for.

" + "description": "

List of organization logins within the enterprise to enable Copilot cloud agent for.

" }, { "type": "array of objects", @@ -114,7 +114,7 @@ ] } ], - "descriptionHTML": "

Enables Copilot coding agent for the specified organizations within the enterprise.

\n

The enterprise's coding agent policy must be set to enabled_for_selected_orgs before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.

\n

Only organizations that have Copilot enabled and belong to the enterprise will be affected.

\n

Only enterprise owners can add organizations to the coding agent policy.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Enables Copilot cloud agent for the specified organizations within the enterprise.

\n

The enterprise's coding agent policy must be set to enabled_for_selected_orgs before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.

\n

Only organizations that have Copilot enabled and belong to the enterprise will be affected.

\n

Only enterprise owners can add organizations to the coding agent policy.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -186,7 +186,7 @@ { "type": "array of strings", "name": "organizations", - "description": "

List of organization logins within the enterprise to disable Copilot coding agent for.

" + "description": "

List of organization logins within the enterprise to disable Copilot cloud agent for.

" }, { "type": "array of objects", @@ -208,7 +208,7 @@ ] } ], - "descriptionHTML": "

Disables Copilot coding agent for the specified organizations within the enterprise.

\n

The enterprise's coding agent policy must be set to enabled_for_selected_orgs before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.

\n

Only organizations that have Copilot enabled and belong to the enterprise will be affected.

\n

Only enterprise owners can remove organizations from the coding agent policy.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Disables Copilot cloud agent for the specified organizations within the enterprise.

\n

The enterprise's coding agent policy must be set to enabled_for_selected_orgs before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.

\n

Only organizations that have Copilot enabled and belong to the enterprise will be affected.

\n

Only enterprise owners can remove organizations from the coding agent policy.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -262,7 +262,7 @@ "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", - "title": "Get Copilot coding agent permissions for an organization", + "title": "Get Copilot cloud agent permissions for an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -277,7 +277,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about which repositories in an organization have been enabled\nor disabled for the Copilot coding agent.

\n

Organization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about which repositories in an organization have been enabled\nor disabled for the Copilot cloud agent.

\n

Organization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -299,7 +299,7 @@ "properties": { "enabled_repositories": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", "selected", @@ -338,7 +338,7 @@ "properties": { "enabled_repositories": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", "selected", @@ -376,7 +376,7 @@ "properties": { "enabled_repositories": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", "selected", @@ -433,7 +433,7 @@ "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions", - "title": "Set Copilot coding agent permissions for an organization", + "title": "Set Copilot cloud agent permissions for an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -451,7 +451,7 @@ { "type": "string", "name": "enabled_repositories", - "description": "

The policy for which repositories can use Copilot coding agent. Can be one of all, selected, or none.

", + "description": "

The policy for which repositories can use Copilot cloud agent. Can be one of all, selected, or none.

", "isRequired": true, "enum": [ "all", @@ -460,7 +460,7 @@ ] } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets the policy for which repositories in an organization can use Copilot coding agent.

\n

Organization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets the policy for which repositories in an organization can use Copilot cloud agent.

\n

Organization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -522,7 +522,7 @@ "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", - "title": "List repositories enabled for Copilot coding agent in an organization", + "title": "List repositories enabled for Copilot cloud agent in an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -555,7 +555,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists the selected repositories that are enabled for Copilot coding agent in an organization.

\n

Organization owners can use this endpoint when the coding agent repository policy\nis set to selected to see which repositories have been enabled.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists the selected repositories that are enabled for Copilot cloud agent in an organization.

\n

Organization owners can use this endpoint when the coding agent repository policy\nis set to selected to see which repositories have been enabled.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -1593,7 +1593,7 @@ "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories", - "title": "Set selected repositories for Copilot coding agent in an organization", + "title": "Set selected repositories for Copilot cloud agent in an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -1611,11 +1611,11 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

List of repository IDs to enable for Copilot coding agent.

", + "description": "

List of repository IDs to enable for Copilot cloud agent.

", "isRequired": true } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Replaces the list of selected repositories that are enabled for Copilot coding\nagent in an organization. This method can only be called when the coding agent\nrepository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Replaces the list of selected repositories that are enabled for Copilot cloud\nagent in an organization. This method can only be called when the cloud agent\nrepository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -1684,7 +1684,7 @@ "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", - "title": "Enable a repository for Copilot coding agent in an organization", + "title": "Enable a repository for Copilot cloud agent in an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -1708,7 +1708,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Adds a repository to the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Adds a repository to the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -1772,7 +1772,7 @@ "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}", - "title": "Disable a repository for Copilot coding agent in an organization", + "title": "Disable a repository for Copilot cloud agent in an organization", "category": "copilot", "subcategory": "copilot-coding-agent-management", "parameters": [ @@ -1796,7 +1796,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Removes a repository from the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Removes a repository from the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scopes to use this endpoint.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/enterprise-admin.json b/src/rest/data/ghec-2026-03-10/enterprise-admin.json index 5144cf5353b0..de91480fd5eb 100644 --- a/src/rest/data/ghec-2026-03-10/enterprise-admin.json +++ b/src/rest/data/ghec-2026-03-10/enterprise-admin.json @@ -8837,7 +8837,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -9690,7 +9690,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -10928,7 +10928,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -11636,7 +11636,7 @@ { "type": "integer or null", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.

" + "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin, EnterpriseOwner and EnterpriseRole are not applicable for personal repositories.

" }, { "type": "string", @@ -11649,7 +11649,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ] }, { @@ -13201,7 +13202,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -13211,7 +13212,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -14377,7 +14379,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -14387,7 +14389,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -14633,7 +14635,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -14643,7 +14645,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -15809,7 +15812,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -15819,7 +15822,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -15981,7 +15984,7 @@ { "type": "integer or null", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.

" + "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin, EnterpriseOwner and EnterpriseRole are not applicable for personal repositories.

" }, { "type": "string", @@ -15994,7 +15997,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ] }, { @@ -17547,7 +17551,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -17557,7 +17561,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -18723,7 +18728,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -18733,7 +18738,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", diff --git a/src/rest/data/ghec-2026-03-10/orgs.json b/src/rest/data/ghec-2026-03-10/orgs.json index 0e54c18e2d41..caec43e1968e 100644 --- a/src/rest/data/ghec-2026-03-10/orgs.json +++ b/src/rest/data/ghec-2026-03-10/orgs.json @@ -488,32 +488,32 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_custom_link": { @@ -525,7 +525,7 @@ }, "secret_scanning_validity_checks_enabled": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "deprecated": true }, "created_at": { @@ -1123,32 +1123,32 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_custom_link": { @@ -1160,7 +1160,7 @@ }, "secret_scanning_validity_checks_enabled": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "deprecated": true }, "created_at": { @@ -2511,7 +2511,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -25523,7 +25523,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -25533,7 +25533,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -26699,7 +26700,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -26709,7 +26710,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -26865,7 +26866,7 @@ { "type": "integer or null", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.

" + "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin, EnterpriseOwner and EnterpriseRole are not applicable for personal repositories.

" }, { "type": "string", @@ -26878,7 +26879,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ] }, { @@ -28078,7 +28080,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -28088,7 +28090,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -29254,7 +29257,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -29264,7 +29267,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -29533,7 +29536,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -29543,7 +29546,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -30709,7 +30713,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -30719,7 +30723,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -30880,7 +30884,7 @@ { "type": "integer or null", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.

" + "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin, EnterpriseOwner and EnterpriseRole are not applicable for personal repositories.

" }, { "type": "string", @@ -30893,7 +30897,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ] }, { @@ -32094,7 +32099,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -32104,7 +32109,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -33270,7 +33276,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -33280,7 +33286,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -34996,7 +35002,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -35125,7 +35131,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ diff --git a/src/rest/data/ghec-2026-03-10/repos.json b/src/rest/data/ghec-2026-03-10/repos.json index 084271bf1d0e..9dbb15528533 100644 --- a/src/rest/data/ghec-2026-03-10/repos.json +++ b/src/rest/data/ghec-2026-03-10/repos.json @@ -37822,7 +37822,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -37832,7 +37832,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -38154,7 +38154,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -38164,7 +38164,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -39330,7 +39331,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -39340,7 +39341,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -39505,7 +39506,7 @@ { "type": "integer or null", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.

" + "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin, EnterpriseOwner and EnterpriseRole are not applicable for personal repositories.

" }, { "type": "string", @@ -39518,7 +39519,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ] }, { @@ -40617,7 +40619,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -40627,7 +40629,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -41793,7 +41796,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -41803,7 +41806,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -42082,7 +42085,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -42092,7 +42095,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -43258,7 +43262,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -43268,7 +43272,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -43438,7 +43442,7 @@ { "type": "integer or null", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.

" + "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin, EnterpriseOwner and EnterpriseRole are not applicable for personal repositories.

" }, { "type": "string", @@ -43451,7 +43455,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ] }, { @@ -44551,7 +44556,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -44561,7 +44566,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -45727,7 +45733,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -45737,7 +45743,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -46401,7 +46407,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -46684,7 +46690,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -46923,7 +46929,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -47213,7 +47219,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -47478,7 +47484,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -47615,7 +47621,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ diff --git a/src/rest/data/ghec-2026-03-10/secret-scanning.json b/src/rest/data/ghec-2026-03-10/secret-scanning.json index 926e59e67356..b0fb3cfa896c 100644 --- a/src/rest/data/ghec-2026-03-10/secret-scanning.json +++ b/src/rest/data/ghec-2026-03-10/secret-scanning.json @@ -578,7 +578,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -2459,7 +2459,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -4294,7 +4294,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -5515,7 +5515,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -6513,6 +6513,16 @@ "type": "string or null", "name": "assignee", "description": "

The username of the user to assign to the alert. Set to null to unassign the alert.

" + }, + { + "type": "string or null", + "name": "validity", + "description": "

Sets the validity of the secret scanning alert. Can be active, inactive, or null to clear the override.

", + "enum": [ + "active", + "inactive", + null + ] } ], "descriptionHTML": "

Updates the status of a secret scanning alert in an eligible repository.

\n

You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.

\n

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

", @@ -6805,7 +6815,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -7719,7 +7729,7 @@ }, { "httpStatusCode": "422", - "description": "

State does not match the resolution or resolution comment, or assignee does not have write access to the repository

" + "description": "

State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert

" }, { "httpStatusCode": "503", diff --git a/src/rest/data/ghes-3.14-2022-11-28/apps.json b/src/rest/data/ghes-3.14-2022-11-28/apps.json index 4453b61ae7c9..ec9593138868 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/apps.json +++ b/src/rest/data/ghes-3.14-2022-11-28/apps.json @@ -1816,7 +1816,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -2752,7 +2752,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3494,7 +3494,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -4103,7 +4103,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -5447,7 +5447,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -6194,7 +6194,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7517,7 +7517,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -8463,7 +8463,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -9407,7 +9407,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -11349,7 +11349,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -13411,7 +13411,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -14329,7 +14329,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.14-2022-11-28/enterprise-admin.json b/src/rest/data/ghes-3.14-2022-11-28/enterprise-admin.json index e751e10ce8da..b54041d9bb45 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/enterprise-admin.json +++ b/src/rest/data/ghes-3.14-2022-11-28/enterprise-admin.json @@ -15633,7 +15633,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -16889,7 +16889,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -17736,7 +17736,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.14-2022-11-28/oauth-authorizations.json b/src/rest/data/ghes-3.14-2022-11-28/oauth-authorizations.json index 9cc4ae27a0ad..96d097dc6874 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/oauth-authorizations.json +++ b/src/rest/data/ghes-3.14-2022-11-28/oauth-authorizations.json @@ -1154,7 +1154,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -2076,7 +2076,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3009,7 +3009,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3859,7 +3859,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -4797,7 +4797,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -5648,7 +5648,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -6533,7 +6533,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7463,7 +7463,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.14-2022-11-28/orgs.json b/src/rest/data/ghes-3.14-2022-11-28/orgs.json index bd285ea83e09..d9b86358544b 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/orgs.json +++ b/src/rest/data/ghes-3.14-2022-11-28/orgs.json @@ -2322,7 +2322,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.15-2022-11-28/apps.json b/src/rest/data/ghes-3.15-2022-11-28/apps.json index 120a839845af..613fcac28e77 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/apps.json +++ b/src/rest/data/ghes-3.15-2022-11-28/apps.json @@ -1822,7 +1822,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -2766,7 +2766,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3516,7 +3516,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -4134,7 +4134,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -5486,7 +5486,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -6242,7 +6242,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7576,7 +7576,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -8530,7 +8530,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -9482,7 +9482,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -11432,7 +11432,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -13502,7 +13502,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -14428,7 +14428,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.15-2022-11-28/enterprise-admin.json b/src/rest/data/ghes-3.15-2022-11-28/enterprise-admin.json index e2a9706472f2..05c5e896155f 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/enterprise-admin.json +++ b/src/rest/data/ghes-3.15-2022-11-28/enterprise-admin.json @@ -14322,7 +14322,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -15586,7 +15586,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -16441,7 +16441,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.15-2022-11-28/oauth-authorizations.json b/src/rest/data/ghes-3.15-2022-11-28/oauth-authorizations.json index 96575efc4b5c..23b408d7f5f8 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/oauth-authorizations.json +++ b/src/rest/data/ghes-3.15-2022-11-28/oauth-authorizations.json @@ -1154,7 +1154,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -2084,7 +2084,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3025,7 +3025,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3883,7 +3883,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -4829,7 +4829,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -5688,7 +5688,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -6581,7 +6581,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7519,7 +7519,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.15-2022-11-28/orgs.json b/src/rest/data/ghes-3.15-2022-11-28/orgs.json index 012a589ded83..adc38a201cc8 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/orgs.json +++ b/src/rest/data/ghes-3.15-2022-11-28/orgs.json @@ -2322,7 +2322,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.16-2022-11-28/apps.json b/src/rest/data/ghes-3.16-2022-11-28/apps.json index bbab22ccd9b8..076ad36fae64 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/apps.json +++ b/src/rest/data/ghes-3.16-2022-11-28/apps.json @@ -1822,7 +1822,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -2774,7 +2774,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3532,7 +3532,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -4159,7 +4159,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -5519,7 +5519,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -6284,7 +6284,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7626,7 +7626,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -8588,7 +8588,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -9548,7 +9548,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -11506,7 +11506,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -13584,7 +13584,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -14518,7 +14518,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.16-2022-11-28/enterprise-admin.json b/src/rest/data/ghes-3.16-2022-11-28/enterprise-admin.json index e1b34a362ab3..a0df40fa138a 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/enterprise-admin.json +++ b/src/rest/data/ghes-3.16-2022-11-28/enterprise-admin.json @@ -15553,7 +15553,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -16825,7 +16825,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -17688,7 +17688,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.16-2022-11-28/oauth-authorizations.json b/src/rest/data/ghes-3.16-2022-11-28/oauth-authorizations.json index c5bbb2672776..63316887e53c 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/oauth-authorizations.json +++ b/src/rest/data/ghes-3.16-2022-11-28/oauth-authorizations.json @@ -1154,7 +1154,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -2092,7 +2092,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3041,7 +3041,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3907,7 +3907,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -4861,7 +4861,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -5728,7 +5728,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -6629,7 +6629,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7575,7 +7575,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.16-2022-11-28/orgs.json b/src/rest/data/ghes-3.16-2022-11-28/orgs.json index 44fa86542d7e..e3fe4559bfc0 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/orgs.json +++ b/src/rest/data/ghes-3.16-2022-11-28/orgs.json @@ -2337,7 +2337,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.17-2022-11-28/apps.json b/src/rest/data/ghes-3.17-2022-11-28/apps.json index f6498fec2f9c..5af1618bd149 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/apps.json +++ b/src/rest/data/ghes-3.17-2022-11-28/apps.json @@ -1822,7 +1822,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -2774,7 +2774,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3532,7 +3532,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -4159,7 +4159,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -5519,7 +5519,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -6284,7 +6284,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7626,7 +7626,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -8588,7 +8588,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -9548,7 +9548,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -11506,7 +11506,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -13584,7 +13584,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -14518,7 +14518,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.17-2022-11-28/enterprise-admin.json b/src/rest/data/ghes-3.17-2022-11-28/enterprise-admin.json index 196ed90894ff..c8f70d08d26e 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/enterprise-admin.json +++ b/src/rest/data/ghes-3.17-2022-11-28/enterprise-admin.json @@ -15582,7 +15582,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -16854,7 +16854,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -17717,7 +17717,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.17-2022-11-28/oauth-authorizations.json b/src/rest/data/ghes-3.17-2022-11-28/oauth-authorizations.json index 3dfdafb3073f..f5e34e84e073 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/oauth-authorizations.json +++ b/src/rest/data/ghes-3.17-2022-11-28/oauth-authorizations.json @@ -1154,7 +1154,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -2092,7 +2092,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3041,7 +3041,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3907,7 +3907,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -4861,7 +4861,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -5728,7 +5728,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -6629,7 +6629,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7575,7 +7575,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.17-2022-11-28/orgs.json b/src/rest/data/ghes-3.17-2022-11-28/orgs.json index f56977e495b8..106710fc64fd 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/orgs.json +++ b/src/rest/data/ghes-3.17-2022-11-28/orgs.json @@ -2337,7 +2337,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.18-2022-11-28/apps.json b/src/rest/data/ghes-3.18-2022-11-28/apps.json index 96d0e3e42e3a..ce39ff4beb99 100644 --- a/src/rest/data/ghes-3.18-2022-11-28/apps.json +++ b/src/rest/data/ghes-3.18-2022-11-28/apps.json @@ -1822,7 +1822,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -2774,7 +2774,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3532,7 +3532,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -4159,7 +4159,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -5519,7 +5519,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -6284,7 +6284,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7626,7 +7626,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -8588,7 +8588,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -9548,7 +9548,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -11506,7 +11506,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -13584,7 +13584,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -14518,7 +14518,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.18-2022-11-28/enterprise-admin.json b/src/rest/data/ghes-3.18-2022-11-28/enterprise-admin.json index f2a599fc1aef..32ecf8a87bbd 100644 --- a/src/rest/data/ghes-3.18-2022-11-28/enterprise-admin.json +++ b/src/rest/data/ghes-3.18-2022-11-28/enterprise-admin.json @@ -16717,7 +16717,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -17989,7 +17989,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -18852,7 +18852,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.18-2022-11-28/oauth-authorizations.json b/src/rest/data/ghes-3.18-2022-11-28/oauth-authorizations.json index c37aa762db73..dc1b317f0186 100644 --- a/src/rest/data/ghes-3.18-2022-11-28/oauth-authorizations.json +++ b/src/rest/data/ghes-3.18-2022-11-28/oauth-authorizations.json @@ -1154,7 +1154,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -2092,7 +2092,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3041,7 +3041,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3907,7 +3907,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -4861,7 +4861,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -5728,7 +5728,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -6629,7 +6629,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7575,7 +7575,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.18-2022-11-28/orgs.json b/src/rest/data/ghes-3.18-2022-11-28/orgs.json index f0cd3a2c3eca..42b00c002773 100644 --- a/src/rest/data/ghes-3.18-2022-11-28/orgs.json +++ b/src/rest/data/ghes-3.18-2022-11-28/orgs.json @@ -2337,7 +2337,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.19-2022-11-28/apps.json b/src/rest/data/ghes-3.19-2022-11-28/apps.json index 9cc5a80744a6..d1c08b7dd8ba 100644 --- a/src/rest/data/ghes-3.19-2022-11-28/apps.json +++ b/src/rest/data/ghes-3.19-2022-11-28/apps.json @@ -1822,7 +1822,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -2790,7 +2790,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3564,7 +3564,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -4209,7 +4209,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -5585,7 +5585,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -6368,7 +6368,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7726,7 +7726,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -8704,7 +8704,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -9680,7 +9680,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -11654,7 +11654,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -13748,7 +13748,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -14698,7 +14698,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.19-2022-11-28/enterprise-admin.json b/src/rest/data/ghes-3.19-2022-11-28/enterprise-admin.json index dabc109e7a32..a8d4f1d1a7fa 100644 --- a/src/rest/data/ghes-3.19-2022-11-28/enterprise-admin.json +++ b/src/rest/data/ghes-3.19-2022-11-28/enterprise-admin.json @@ -9945,7 +9945,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -10797,7 +10797,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -12034,7 +12034,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -20818,7 +20818,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -22106,7 +22106,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -22985,7 +22985,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.19-2022-11-28/oauth-authorizations.json b/src/rest/data/ghes-3.19-2022-11-28/oauth-authorizations.json index c3f8d2df75da..cee8a8bd7d9a 100644 --- a/src/rest/data/ghes-3.19-2022-11-28/oauth-authorizations.json +++ b/src/rest/data/ghes-3.19-2022-11-28/oauth-authorizations.json @@ -1154,7 +1154,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -2108,7 +2108,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3073,7 +3073,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3955,7 +3955,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -4925,7 +4925,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -5808,7 +5808,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -6725,7 +6725,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7687,7 +7687,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.19-2022-11-28/orgs.json b/src/rest/data/ghes-3.19-2022-11-28/orgs.json index 31062ff2c169..df61bf5720bc 100644 --- a/src/rest/data/ghes-3.19-2022-11-28/orgs.json +++ b/src/rest/data/ghes-3.19-2022-11-28/orgs.json @@ -2337,7 +2337,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.20-2022-11-28/apps.json b/src/rest/data/ghes-3.20-2022-11-28/apps.json index 3f451b22990b..394b01ae1359 100644 --- a/src/rest/data/ghes-3.20-2022-11-28/apps.json +++ b/src/rest/data/ghes-3.20-2022-11-28/apps.json @@ -1830,7 +1830,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -2815,7 +2815,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3607,7 +3607,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -4270,7 +4270,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -5664,7 +5664,7 @@ { "type": "string", "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.

", + "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", "enum": [ "read", "write" @@ -6465,7 +6465,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7840,7 +7840,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -8835,7 +8835,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -9828,7 +9828,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -11819,7 +11819,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -13930,7 +13930,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -14897,7 +14897,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.20-2022-11-28/enterprise-admin.json b/src/rest/data/ghes-3.20-2022-11-28/enterprise-admin.json index 453cb002c4e8..06ab8f8be804 100644 --- a/src/rest/data/ghes-3.20-2022-11-28/enterprise-admin.json +++ b/src/rest/data/ghes-3.20-2022-11-28/enterprise-admin.json @@ -9960,7 +9960,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -10829,7 +10829,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -12083,7 +12083,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -20884,7 +20884,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -22189,7 +22189,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -23085,7 +23085,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.20-2022-11-28/oauth-authorizations.json b/src/rest/data/ghes-3.20-2022-11-28/oauth-authorizations.json index 2c456d555e94..60d095a932e6 100644 --- a/src/rest/data/ghes-3.20-2022-11-28/oauth-authorizations.json +++ b/src/rest/data/ghes-3.20-2022-11-28/oauth-authorizations.json @@ -1162,7 +1162,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -2133,7 +2133,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -3115,7 +3115,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -4014,7 +4014,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -5001,7 +5001,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -5901,7 +5901,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -6835,7 +6835,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7814,7 +7814,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.20-2022-11-28/orgs.json b/src/rest/data/ghes-3.20-2022-11-28/orgs.json index 9b58758d5058..34344c504c36 100644 --- a/src/rest/data/ghes-3.20-2022-11-28/orgs.json +++ b/src/rest/data/ghes-3.20-2022-11-28/orgs.json @@ -2345,7 +2345,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/src/rest/data/ghes-3.20-2022-11-28/secret-scanning.json b/src/rest/data/ghes-3.20-2022-11-28/secret-scanning.json index d05d4535bc37..b10d80021bee 100644 --- a/src/rest/data/ghes-3.20-2022-11-28/secret-scanning.json +++ b/src/rest/data/ghes-3.20-2022-11-28/secret-scanning.json @@ -6630,7 +6630,7 @@ }, { "httpStatusCode": "422", - "description": "

State does not match the resolution or resolution comment, or assignee does not have write access to the repository

" + "description": "

State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert

" }, { "httpStatusCode": "503", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index a2432d0e0a1d..e42b1b85c502 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -55,5 +55,5 @@ ] } }, - "sha": "d786d3f083a842b342a5395a58ca01cd0faa71e6" + "sha": "d3a3c2a50bb45b5f437bdfd8e0c700091bb1fb7b" } \ No newline at end of file diff --git a/src/webhooks/data/ghec/repository_ruleset.json b/src/webhooks/data/ghec/repository_ruleset.json index 33c750d7ccc8..1c3e3f60af28 100644 --- a/src/webhooks/data/ghec/repository_ruleset.json +++ b/src/webhooks/data/ghec/repository_ruleset.json @@ -101,7 +101,7 @@ { "type": "integer or null", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.

" + "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin, EnterpriseOwner and EnterpriseRole are not applicable for personal repositories.

" }, { "type": "string", @@ -114,7 +114,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ] }, { @@ -1209,7 +1210,7 @@ { "type": "integer or null", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.

" + "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin, EnterpriseOwner and EnterpriseRole are not applicable for personal repositories.

" }, { "type": "string", @@ -1222,7 +1223,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ] }, { @@ -2317,7 +2319,7 @@ { "type": "integer or null", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin and EnterpriseOwner are not applicable for personal repositories.

" + "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. If actor_type is EnterpriseOwner, actor_id is ignored. OrganizationAdmin, EnterpriseOwner and EnterpriseRole are not applicable for personal repositories.

" }, { "type": "string", @@ -2330,7 +2332,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ] }, { diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 3dc1d8c80680..7b9bdef0a537 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "d786d3f083a842b342a5395a58ca01cd0faa71e6" + "sha": "d3a3c2a50bb45b5f437bdfd8e0c700091bb1fb7b" } \ No newline at end of file