diff --git a/assets/images/help/copilot/spark-data-access.png b/assets/images/help/copilot/spark-data-access.png new file mode 100644 index 000000000000..2de58a5b29cd Binary files /dev/null and b/assets/images/help/copilot/spark-data-access.png differ diff --git a/content/admin/data-residency/feature-overview-for-github-enterprise-cloud-with-data-residency.md b/content/admin/data-residency/feature-overview-for-github-enterprise-cloud-with-data-residency.md index a1e8f61048fa..055e14eea8ef 100644 --- a/content/admin/data-residency/feature-overview-for-github-enterprise-cloud-with-data-residency.md +++ b/content/admin/data-residency/feature-overview-for-github-enterprise-cloud-with-data-residency.md @@ -21,11 +21,12 @@ The following features are currently unavailable on {% data variables.enterprise | Feature | Details | More information | | :- | :- | :- | | {% data variables.product.prodname_github_codespaces %} | Currently unavailable. | [AUTOTITLE](/codespaces/quickstart) | -| {% data variables.product.prodname_marketplace %} | Currently, apps from {% data variables.product.prodname_marketplace %} are unavailable. {% data variables.product.prodname_actions %} workflows from {% data variables.product.prodname_marketplace %} may not function as expected. For more information, see [GitHub Actions workflows from GitHub Marketplace](#github-actions-workflows-from-github-marketplace). | [AUTOTITLE](/search-github/searching-on-github/searching-github-marketplace) | [AUTOTITLE](/enterprise-server@latest/admin/configuration/configuring-github-connect/about-github-connect#github-connect-features) in the {% data variables.product.prodname_ghe_server %} documentation | +| {% data variables.product.prodname_marketplace %} | Currently, apps from {% data variables.product.prodname_marketplace %} are unavailable. {% data variables.product.prodname_actions %} workflows from {% data variables.product.prodname_marketplace %} may not function as expected. For more information, see [{% data variables.product.prodname_actions %} workflows from {% data variables.product.prodname_marketplace %}](#github-actions-workflows-from-github-marketplace). | [AUTOTITLE](/search-github/searching-on-github/searching-github-marketplace) | [AUTOTITLE](/enterprise-server@latest/admin/configuration/configuring-github-connect/about-github-connect#github-connect-features) in the {% data variables.product.prodname_ghe_server %} documentation | | macOS runners for {% data variables.product.prodname_actions %} | Currently unavailable. | [AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners) | | Maven and Gradle support for {% data variables.product.prodname_registry %} | Currently unavailable. | [AUTOTITLE](/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry) | | {% data variables.product.prodname_importer %} (the "Import repository" button on {% data variables.product.prodname_dotcom_the_website %}) | Instead, the **{% data variables.product.prodname_importer_proper_name %}** is available to migrate data. See [AUTOTITLE](/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/about-github-enterprise-importer). | [AUTOTITLE](/migrations/importing-source-code/using-github-importer/about-github-importer) | | {% data variables.product.prodname_copilot_short %} Metrics API | Currently unavailable | [AUTOTITLE](/rest/copilot/copilot-metrics) | +| {% data variables.product.prodname_spark_short %} | Unavailable due to dependency on {% data variables.product.prodname_github_codespaces %} | [AUTOTITLE](/copilot/concepts/spark) | | Restricting {% data variables.product.prodname_actions %} policies to verified creators | Currently unavailable | [AUTOTITLE](/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#allow-enterprise-and-select-non-enterprise-actions-and-reusable-workflows) | | {% data variables.product.prodname_github_models %} | Currently unavailable | [AUTOTITLE](/github-models/about-github-models) | | Some features currently in {% data variables.release-phases.public_preview %} or {% data variables.release-phases.private_preview %} | Certain features that are in a preview phase on {% data variables.product.prodname_dotcom_the_website %} may not be available on {% data variables.enterprise.data_residency_site %} | | diff --git a/content/billing/concepts/billing-cycles.md b/content/billing/concepts/billing-cycles.md index ed45c77463ed..ecf4d1354309 100644 --- a/content/billing/concepts/billing-cycles.md +++ b/content/billing/concepts/billing-cycles.md @@ -38,6 +38,8 @@ At the end of each month, your metered usage is calculated and scheduled to be b Volume-based licenses may follow a different billing cycle. These products are often billed based on the anniversary date of your subscription rather than by calendar month. +You can switch between annual and monthly billing from the "Licensing" page under "Billing and licensing", see [AUTOTITLE](/copilot/how-tos/manage-your-account/view-and-change-your-copilot-plan#changing-your-billing-cycle). + ## How mid-cycle changes affect your billing Mid-cycle changes to your account can affect your bill. diff --git a/content/copilot/concepts/agents/coding-agent/about-coding-agent.md b/content/copilot/concepts/agents/coding-agent/about-coding-agent.md index 448116e654fd..3a4b33e44fa9 100644 --- a/content/copilot/concepts/agents/coding-agent/about-coding-agent.md +++ b/content/copilot/concepts/agents/coding-agent/about-coding-agent.md @@ -142,9 +142,11 @@ Users can include hidden messages in issues assigned to {% data variables.produc * **{% data variables.copilot.copilot_coding_agent %} does not work in personal repositories owned by {% data variables.enterprise.prodname_managed_users %}**. This is because {% data variables.copilot.copilot_coding_agent %} requires {% data variables.product.company_short %}-hosted runners, which are not available to repositories owned by {% data variables.enterprise.prodname_managed_users %}. See [AUTOTITLE](/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners). * **{% data variables.product.prodname_copilot_short %} doesn't account for content exclusions**. Content exclusions allow administrators to configure {% data variables.product.prodname_copilot_short %} to ignore certain files. When using {% data variables.copilot.copilot_coding_agent %}, {% data variables.product.prodname_copilot_short %} will not ignore these files, and will be able to see and update them. See [AUTOTITLE](/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot). * **{% data variables.copilot.copilot_coding_agent %} only works with repositories hosted on {% data variables.product.github %}**. If your repository is stored using a different code hosting platform, {% data variables.product.prodname_copilot_short %} won't be able to work on it. -* **You cannot change the AI model used by {% data variables.copilot.copilot_coding_agent %}**. The model is determined by {% data variables.product.company_short %} and does not inherit the model selected for {% data variables.copilot.copilot_chat %}. +* **You cannot select the AI model used by {% data variables.copilot.copilot_coding_agent %}**. A model picker is not available to switch between models, and {% data variables.product.company_short %} reserves the right to change models at any time. - Currently the model used by {% data variables.copilot.copilot_coding_agent %} is {% data variables.copilot.cca_current_model %}. {% data variables.product.github %} reserves the right to change this model. + If you are a {% data variables.copilot.copilot_pro %} or {% data variables.copilot.copilot_pro_plus %} subscriber, {% data variables.copilot.copilot_coding_agent %} uses {% data variables.copilot.copilot_claude_sonnet_45 %}. + + If you are a {% data variables.copilot.copilot_for_business %} or {% data variables.copilot.copilot_enterprise %} subscriber, {% data variables.copilot.copilot_coding_agent %} uses {% data variables.copilot.cca_current_model %} by default, or {% data variables.copilot.copilot_claude_sonnet_45 %} if the model has been enabled by an administrator. See [AUTOTITLE](/copilot/concepts/policies). ## Hands-on practice diff --git a/content/copilot/concepts/spark.md b/content/copilot/concepts/spark.md index 7aced0339049..c23ba2d67b45 100644 --- a/content/copilot/concepts/spark.md +++ b/content/copilot/concepts/spark.md @@ -56,7 +56,7 @@ All sparks are hosted and deployed by Azure Container Apps (ACA). #### Create a repository with two-way syncing * You can create a repository for your spark in one click, allowing you to manage your app's code and collaborate with others using standard {% data variables.product.github %} workflows. - + * There's a two-way sync between your spark and the repository, so changes made in either {% data variables.product.prodname_spark_short %} or the main branch of your repository are automatically reflected in both places. Any changes made to your spark prior to repository creation will be added to your repository so you have a full record of all changes and commits made to your spark since its creation. #### Invite collaborators @@ -67,6 +67,34 @@ All sparks are hosted and deployed by Azure Container Apps (ACA). * Once you've created a repository for your spark, you can use all the standard {% data variables.product.github %} features such as pull requests, issues, and project boards to manage your spark development process, as well as leverage {% data variables.product.prodname_actions %} for CI/CD workflows. +## Enterprise considerations + +If you’re an enterprise admin evaluating {% data variables.product.prodname_spark_short %}, there are specific benefits and controls available at the enterprise level. + +For details about enabling {% data variables.product.prodname_spark_short %} for your enterprise, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-spark). + +### Why enable {% data variables.product.prodname_spark_short %} for your enterprise? + +Enabling {% data variables.product.prodname_spark_short %} empowers your teams to move faster from idea to production while maintaining the security, governance, and cost controls that enterprise admins expect. + +Benefits include: + +* **Centralized control**. {% data variables.product.prodname_spark_short %} is included in the {% data variables.product.prodname_copilot_short %} license and respects existing enterprise access policies. +* **Governance and security**. Built on {% data variables.product.github %} and Azure, sparks inherit enterprise-grade reliability, authentication, and compliance. +* **Transparency and cost management**. {% data variables.product.prodname_spark_short %} consumption draws from {% data variables.product.prodname_copilot_short %} premium requests, which you can monitor through the {% data variables.product.github %} billing platform. +* **Accelerated innovation**. Teams can validate ideas in hours instead of months, without relying on fragmented toolchains. + +### Billing + +Each natural-language prompt in {% data variables.product.prodname_spark_short %} consumes four premium requests. +See [AUTOTITLE](/copilot/concepts/billing/billing-for-spark). + +### Infrastructure + +The {% data variables.product.prodname_spark_short %} development environment is powered by {% data variables.product.prodname_github_codespaces %}. If your enterprise disables {% data variables.product.prodname_codespaces %}, users can still access the {% data variables.product.prodname_spark_short %} interface but won’t be able to open the underlying codespace. + +All sparks are deployed to Azure Container Apps (ACA). + ## Develop your spark with {% data variables.product.prodname_copilot_short %} You can combine the functionality of {% data variables.product.prodname_spark %} with {% data variables.product.prodname_copilot %} to support your app development. @@ -93,7 +121,7 @@ When you're ready to publish your spark, you can choose from the following visib * Private to you only * Visible to members of a specific organization on {% data variables.product.github %} -* Visible to all {% data variables.product.github %} users. +* Visible to all {% data variables.product.github %} users (may be disabled for certain {% data variables.enterprise.prodname_managed_users %} based on admin configuration) You can then share your spark with others, so they can view and interact with your app. The link to your spark remains undiscoverable except for those who have the link. diff --git a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/index.md b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/index.md index 60034d21afc9..e2412289efc4 100644 --- a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/index.md +++ b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/index.md @@ -12,6 +12,7 @@ children: - /manage-enterprise-policies - /manage-copilot-coding-agent - /manage-copilot-code-review + - /manage-spark redirect_from: - /copilot/managing-copilot/managing-copilot-for-your-enterprise - /copilot/how-tos/administer/enterprises diff --git a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-copilot-code-review.md b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-copilot-code-review.md index 691ca233215a..a0094bc2c4f8 100644 --- a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-copilot-code-review.md +++ b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-copilot-code-review.md @@ -19,7 +19,7 @@ For more information about {% data variables.copilot.copilot_for_prs %}, see [AU ## Enabling {% data variables.copilot.copilot_code-review_short %} for your {% data variables.product.prodname_copilot_short %} subscribers -You can enable {% data variables.copilot.copilot_code-review_short %} and {% data variables.copilot.copilot_for_prs %} for your members on the {% data variables.product.prodname_copilot_short %} policies page for your enterprise. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#configuring-policies-for-github-copilot). +You can enable {% data variables.copilot.copilot_code-review_short %} and {% data variables.copilot.copilot_for_prs %} for your members on the {% data variables.product.prodname_copilot_short %} policies page for your enterprise. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#defining-policies-for-your-enterprise). * "Enabled" means all users granted a {% data variables.product.prodname_copilot_short %} license by any of your organizations will be able to use the feature. * "Disabled" means no users granted a {% data variables.product.prodname_copilot_short %} license by your organizations will be able to use the feature. diff --git a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-spark.md b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-spark.md new file mode 100644 index 000000000000..f8991a5de526 --- /dev/null +++ b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-spark.md @@ -0,0 +1,56 @@ +--- +title: Managing GitHub Spark in your enterprise +shortTitle: 'Manage {% data variables.product.prodname_spark_short %}' +intro: 'Enable and manage {% data variables.product.prodname_spark %} for your enterprise.' +permissions: Enterprise owners +product: 'Enterprises with a {% data variables.copilot.copilot_enterprise_short %} plan' +versions: + feature: spark +allowTitleToDifferFromFilename: true +topics: + - Copilot +--- + +> [!NOTE] +> * {% data reusables.spark.preview-note-spark %} +> * {% data reusables.copilot.spark-data-res %} + +## About {% data variables.product.prodname_spark_short %} + +{% data variables.product.prodname_spark_short %} allows users to build intelligent applications using natural-language prompts. {% data variables.product.prodname_spark_short %} includes advanced controls and built-in design tools for customization. Once published, applications can be shared with teammates or deployed to production. + +For details about benefits, development experience, billing, and enterprise considerations, see [AUTOTITLE](/copilot/concepts/spark#enterprise-considerations). + +## Prerequisites + +* Your enterprise must be on a {% data variables.copilot.copilot_enterprise_short %} plan. +* During the {% data variables.release-phases.public_preview %}, the organization or enterprise must have the **Opt in to preview features** setting enabled. See: + * [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#enabling-copilot-features-in-your-organization) + * [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#copilot-in-githubcom) + +## Enabling {% data variables.product.prodname_spark_short %} for your {% data variables.product.prodname_copilot_short %} subscribers + +By default, {% data variables.product.prodname_spark_short %} is **disabled** for users who receive a {% data variables.copilot.copilot_enterprise_short %} license from an enterprise-owned organization. + +You can enable {% data variables.product.prodname_spark_short %} for your members on the {% data variables.product.prodname_copilot_short %} policies page for your enterprise. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#defining-policies-for-your-enterprise). + +* **Enabled**: All users granted a {% data variables.product.prodname_copilot_short %} license by any of your organizations can use {% data variables.product.prodname_spark_short %}. Enable this if your enterprise wants consistent access across all organizations and is ready to roll out {% data variables.product.prodname_spark_short %} broadly. +* **Disabled**: No users granted a {% data variables.product.prodname_copilot_short %} license by your organizations can use {% data variables.product.prodname_spark_short %}. Choose this if {% data variables.product.prodname_spark_short %} isn’t yet approved for use, for example, if your enterprise is still completing policy or security reviews. +* **No policy**: Organization owners in each of your organizations decide whether {% data variables.product.prodname_copilot_short %} licensees can use {% data variables.product.prodname_spark_short %}. Select this if you prefer a phased or opt-in adoption, where individual organizations can trial {% data variables.product.prodname_spark_short %} before a broader rollout. + +### Next steps + +* If you selected **Enabled**, tell organization owners that these features are enabled for all members. +* If you selected **No policy**, discuss member enablement with organization owners. + +{% note %} + +Was this article helpful in enabling and managing {% data variables.product.prodname_spark_short %} for your enterprise? + +Yes No + +{% endnote %} + +## Further reading + +* [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-spark) diff --git a/content/copilot/how-tos/manage-your-account/view-and-change-your-copilot-plan.md b/content/copilot/how-tos/manage-your-account/view-and-change-your-copilot-plan.md index b21a5c78e781..dec4237c300d 100644 --- a/content/copilot/how-tos/manage-your-account/view-and-change-your-copilot-plan.md +++ b/content/copilot/how-tos/manage-your-account/view-and-change-your-copilot-plan.md @@ -92,10 +92,13 @@ You can cancel your {% data variables.copilot.copilot_pro_short %} trial at any If you're on a paid {% data variables.product.prodname_copilot_short %} plan, you can switch between monthly and yearly billing at any time. The change will take effect at the start of your next billing cycle. +> [!TIP] +> If you use volume billing for your {% data variables.product.github %} plan, you can also change your billing cycle for your plan with these steps. + {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.billing-plans-two-platforms %} -1. In the "{% data variables.product.prodname_copilot %}" section, select the **Edit** dropdown on the right. +1. In your {% data variables.product.prodname_copilot %} or {% data variables.product.github %} plan section, select the **Edit** dropdown on the right. 1. Choose the option to switch your billing cycle: * If you're billed monthly, click **Change to yearly billing**. diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs.md b/content/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs.md index 8014c1e38514..659adf2153a0 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs.md +++ b/content/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs.md @@ -39,6 +39,8 @@ When {% data variables.product.prodname_copilot_short %} starts a new agent sess  +When {% data variables.product.prodname_copilot_short %} starts a new session on the same pull request, it remembers context from the previous session, allowing it to work faster and more reliably. + For more information, see the section "Use comments to iterate on a pull request" in [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks#using-comments-to-iterate-on-a-pull-request). ## Managing {% data variables.product.prodname_actions %} workflow runs diff --git a/content/copilot/reference/policy-conflicts.md b/content/copilot/reference/policy-conflicts.md index 6cce1a33b119..a06e90cc7402 100644 --- a/content/copilot/reference/policy-conflicts.md +++ b/content/copilot/reference/policy-conflicts.md @@ -44,7 +44,8 @@ Feature, model, and privacy settings for users are set according to the **least | {% data variables.copilot.copilot_mobile_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat-in-github-mobile) | | {% data variables.copilot.copilot_chat_short %} in the IDE | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat-in-your-ide) | | {% data variables.copilot.copilot_code-review_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/code-review) | -| {% data variables.copilot.copilot_coding_agent %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/copilot-coding-agent) | +| {% data variables.copilot.copilot_coding_agent %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-copilot-coding-agent-on-githubcom) | +| {% data variables.product.prodname_spark_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/spark) | | {% data variables.copilot.copilot_extensions_short %} | Least restrictive organization | [AUTOTITLE](/copilot/concepts/copilot-extensions/about-copilot-extensions) | | {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_dotcom_the_website %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat-in-github) | | {% data variables.copilot.copilot_desktop_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/copilot-in-github-desktop) | diff --git a/content/copilot/responsible-use/spark.md b/content/copilot/responsible-use/spark.md index ebdd66d78fed..f8ac2e64753c 100644 --- a/content/copilot/responsible-use/spark.md +++ b/content/copilot/responsible-use/spark.md @@ -79,7 +79,7 @@ Targeted edits in {% data variables.product.prodname_spark_short %} allow you to While {% data variables.product.prodname_spark_short %} is an extremely powerful tool, it may still make mistakes. These mistakes can be misunderstandings of your goals, or more simple syntax errors within your generated spark. You should always use {% data variables.product.prodname_spark_short %}’s provided application preview to verify that your spark behaves as intended in different scenarios. If you are comfortable with code, it is also best practice to ensure the generated code is up to your code quality standards. -## Limitations of GitHub Spark +## Limitations of {% data variables.product.prodname_spark %} ### Interpretation of user intent @@ -87,7 +87,13 @@ While {% data variables.product.prodname_spark_short %} is an extremely powerful ### Limited scope -{% data variables.product.prodname_spark_short %} is backed by {% data variables.product.prodname_copilot_short %}, and therefore has been trained on a large body of code and relevant applications. However it may still struggle with complex or truly novel applications. {% data variables.product.prodname_spark_short %} will perform best on common/personal application scenarios (e.g. productivity tools, learning aids, life management utilities), and when the natural language instruction is provided in English. +{% data variables.product.prodname_spark_short %} is backed by {% data variables.product.prodname_copilot_short %}, and therefore has been trained on a large body of code and relevant applications. However it may still struggle with complex or truly novel applications. {% data variables.product.prodname_spark_short %} will perform best on common/personal application scenarios (e.g. productivity tools, learning aids, life management utilities), and when the natural language instruction is provided in English. + +### Public code + +{% data variables.product.prodname_spark_short %} may generate code that is a match or near match of publicly available code, even if the "Suggestions matching public code" policy is set to "Block." See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-suggestions-matching-public-code). + +If this happens, {% data variables.product.prodname_copilot_short %} will not provide code references pointing to the original source of the code. See [AUTOTITLE](/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions). ### Security limitations diff --git a/content/copilot/tutorials/roll-out-at-scale/enable-developers/integrate-ai-agents.md b/content/copilot/tutorials/roll-out-at-scale/enable-developers/integrate-ai-agents.md index 05f4358f197e..8c982cda6713 100644 --- a/content/copilot/tutorials/roll-out-at-scale/enable-developers/integrate-ai-agents.md +++ b/content/copilot/tutorials/roll-out-at-scale/enable-developers/integrate-ai-agents.md @@ -44,7 +44,7 @@ To hit a tight deadline, you're aiming to speed up each stage of the process, fo 1. When the PM has worked with {% data variables.product.prodname_copilot_short %} to get an overview of the tasks required, they ask {% data variables.product.prodname_copilot_short %} to **create issues** for each part of the work. - Copilot drafts the issues in immersive view, where the PM can refine them and publish them to the repository. + {% data variables.product.prodname_copilot_short %} drafts the issues in immersive view, where the PM can refine them and publish them to the repository. The PM marks some of the issues as nice-to-haves or maintenance. These may be good candidates for {% data variables.copilot.copilot_coding_agent %}. @@ -54,11 +54,17 @@ To hit a tight deadline, you're aiming to speed up each stage of the process, fo Now, the developer can ask questions in the space, and {% data variables.product.prodname_copilot_short %} will already have all the context the PM added. -## 2. Create with {% data variables.product.prodname_github_models %} and agent mode +## 2. Prototype with {% data variables.product.prodname_spark %} -1. The PM asks the developer to start by finding the best AI model to provide the tailored umbrella recommendations, based on the cost and effectiveness of the models. -1. The developer asks **{% data variables.copilot.copilot_chat_short %}** to recommend several AI models for the job and the pros and cons of each. To provide useful context, they ask Copilot to consider the information in the [AUTOTITLE](/copilot/reference/ai-models/model-comparison) {% data variables.product.prodname_docs %} article. -1. To settle on a model from the shortlist, the developer uses the **{% data variables.product.prodname_github_models %}** playground to compare results from the same prompt across models. They save time by testing models on a single platform, rather than needing to set up an API key for each model separately. +1. To prototype the feature, the PM opens {% data variables.product.prodname_spark %} (`https://github.com/spark`) and prompts it to create the widget. They can write a prompt, paste in documentation from the last phase, or upload a screenshot. {% data variables.product.prodname_spark_short %} generates a working app with an LLM already integrated to power recommendations—no IDE or coding required. +1. To refine the prototype, the PM can prompt {% data variables.product.prodname_spark_short %} again, use the visual editor, or edit the code directly. In the "Prompts" tab, they can adjust the text that powers recommendations without editing code. Each change instantly updates the live preview, so the PM can see how edits affect the app. +1. To collaborate, the PM publishes the spark and updates the visibility so their organization can access it. They can also create a repository and invite collaborators. Code changes made in the repository sync back to {% data variables.product.prodname_spark_short %}, letting the PM and designers see updates to the widget in real time. + +## 3. Create with {% data variables.product.prodname_github_models %} and agent mode + +1. The PM shares the {% data variables.product.prodname_copilot_short %} space and {% data variables.product.prodname_spark %} prototype and repository with the developer and asks the developer to start by finding the best AI model to provide the tailored umbrella recommendations, based on the cost and effectiveness of the models. +1. The developer asks **{% data variables.copilot.copilot_chat_short %}** to recommend several AI models for the job and the pros and cons of each. To provide useful context, they ask {% data variables.product.prodname_copilot_short %} to consider the information in the [AUTOTITLE](/copilot/reference/ai-models/model-comparison) {% data variables.product.prodname_docs %} article. +1. To settle on a model from the shortlist, the developer uses the **{% data variables.product.prodname_github_models %}** playground to compare results from the same prompt across models. They can then also update the {% data variables.product.prodname_spark %} prototype to use the specific model they've selected to see how it impacts the whole widget experience in the prototype (all models supported in {% data variables.product.prodname_github_models %} are supported in {% data variables.product.prodname_spark_short %}). They save time by testing models on a single platform, rather than needing to set up an API key for each model separately.  @@ -81,7 +87,7 @@ To hit a tight deadline, you're aiming to speed up each stage of the process, fo 1. The developer reviews the diff of the agent's work and chooses which code to keep. -## 3. Test with an MCP server +## 4. Test with an MCP server 1. When the code is finished, the developer wants to run tests on their local build of the site using Playwright, an automated in-browser testing service. @@ -95,12 +101,12 @@ To hit a tight deadline, you're aiming to speed up each stage of the process, fo > * With the **{% data variables.product.github %} MCP server** enabled, {% data variables.product.prodname_copilot_short %} can run the command to open a pull request directly from {% data variables.product.prodname_vscode_shortname %}, with the title and description already filled in. > * Interactions with the {% data variables.product.github %} MCP server are secured by **push protection**, which blocks secrets from being included in AI-generated responses and prevents you from exposing secrets through any actions you perform using the server (public repositories only). See [AUTOTITLE](/code-security/secret-scanning/introduction/about-push-protection). -## 4. Review with {% data variables.copilot.copilot_code-review_short %} +## 5. Review with {% data variables.copilot.copilot_code-review_short %} 1. A repository owner has configured automatic **code reviews** by {% data variables.product.prodname_copilot_short %} on the repository. {% data variables.product.prodname_copilot_short %} provides an initial review on the pull request, identifying bugs and potential performance issues that the developer can fix before a human reviewer gets to the pull request. 1. The developer's colleague reviews and approves the pull request. The work is ready to merge. -## 5. Optimize with {% data variables.copilot.copilot_coding_agent %} +## 6. Optimize with {% data variables.copilot.copilot_coding_agent %} 1. After the release, the product manager collects customer feedback and identifies an opportunity to improve the widget's suggestions by switching to a more reliable API for weather data. They create an issue to implement this change, and **assign it to {% data variables.product.prodname_copilot_short %}** directly on {% data variables.product.github %}. 1. {% data variables.copilot.copilot_coding_agent %} works in the background and opens a pull request, which the product manager marks as ready for review. @@ -117,7 +123,7 @@ To hit a tight deadline, you're aiming to speed up each stage of the process, fo 1. {% data variables.product.prodname_copilot_short %} works in the background and opens a pull request on {% data variables.product.github %}, ready for another developer to review. -## 6. Secure with {% data variables.copilot.copilot_autofix_short %} +## 7. Secure with {% data variables.copilot.copilot_autofix_short %} 1. An administrator has enabled {% data variables.product.prodname_code_scanning %} on the repository, and a {% data variables.product.prodname_code_scanning %} alert suggests a potential vulnerability in the code. 1. A security manager requests **{% data variables.copilot.copilot_autofix_short %}** to automatically suggest a fix for the vulnerability, which a developer reviews and approves. @@ -140,12 +146,13 @@ To integrate agentic AI features effectively into your workstreams, you'll need | ------- | ---------------- | | Immersive view of {% data variables.copilot.copilot_chat_short %} | [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github#submitting-a-question-to-copilot-chat) | | {% data variables.copilot.copilot_spaces %} ({% data variables.release-phases.public_preview %}) | [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/about-organizing-and-sharing-context-with-copilot-spaces) | +| {% data variables.product.prodname_spark %} ({% data variables.release-phases.public_preview %}) | [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-spark) | | {% data variables.copilot.copilot_chat_short %} agent mode | [Use agent mode in VS Code](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode) | | Content exclusions | [AUTOTITLE](/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot) | | MCP servers ({% data variables.release-phases.public_preview %}) | [AUTOTITLE](/copilot/customizing-copilot/extending-copilot-chat-with-mcp#configuring-mcp-servers-in-visual-studio-code) | -| GitHub Models playground ({% data variables.release-phases.public_preview %}) | [AUTOTITLE](/github-models/prototyping-with-ai-models#experimenting-with-ai-models-in-the-playground) | +| {% data variables.product.prodname_github_models %} playground ({% data variables.release-phases.public_preview %}) | [AUTOTITLE](/github-models/prototyping-with-ai-models#experimenting-with-ai-models-in-the-playground) | | Custom instructions | [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot?tool=vscode) | -| Copilot code review | [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/automatic-code-review) | +| {% data variables.copilot.copilot_code-review_short %} | [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/automatic-code-review) | | {% data variables.copilot.copilot_coding_agent %} ({% data variables.release-phases.public_preview %}) | [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/enabling-developers/using-copilot-coding-agent-in-org) | | {% data variables.copilot.copilot_autofix_short %} | [AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning) | diff --git a/content/copilot/tutorials/spark/build-apps-with-spark.md b/content/copilot/tutorials/spark/build-apps-with-spark.md index df85b857539d..38301443d9ec 100644 --- a/content/copilot/tutorials/spark/build-apps-with-spark.md +++ b/content/copilot/tutorials/spark/build-apps-with-spark.md @@ -5,7 +5,7 @@ allowTitleToDifferFromFilename: true intro: 'Learn how to build and deploy an intelligent web app with natural language using {% data variables.product.prodname_spark %}.' versions: feature: spark -product: 'Anyone with a {% data variables.copilot.copilot_pro_plus_short %} license can use {% data variables.product.prodname_spark_short %}.' +product: '{% data variables.copilot.copilot_pro_plus_short %}, {% data variables.copilot.copilot_enterprise_short %}' topics: - Copilot redirect_from: @@ -26,7 +26,7 @@ This tutorial will guide you through the full lifecycle of building and deployin ### Prerequisites -* A {% data variables.product.github %} account with {% data variables.copilot.copilot_pro_plus_short %}. +* A {% data variables.product.github %} account with {% data variables.copilot.copilot_pro_plus_short %} or {% data variables.copilot.copilot_enterprise_short %} license. ## Step 1: Create your web app diff --git a/content/copilot/tutorials/spark/prompt-tips.md b/content/copilot/tutorials/spark/prompt-tips.md index ca3d87f8ac69..c5c44686c34a 100644 --- a/content/copilot/tutorials/spark/prompt-tips.md +++ b/content/copilot/tutorials/spark/prompt-tips.md @@ -5,7 +5,7 @@ intro: 'Learn how to get the best results when you are describing your app idea allowTitleToDifferFromFilename: true versions: feature: spark -product: 'Anyone with a {% data variables.copilot.copilot_pro_plus_short %} license can use {% data variables.product.prodname_spark_short %}.' +product: 'Anyone with a {% data variables.copilot.copilot_pro_plus_short %} or {% data variables.copilot.copilot_enterprise_short %} license can use {% data variables.product.prodname_spark_short %}.' contentType: tutorials --- diff --git a/content/copilot/tutorials/spark/your-first-spark.md b/content/copilot/tutorials/spark/your-first-spark.md index ef27fc48ba0c..a7786ad4e477 100644 --- a/content/copilot/tutorials/spark/your-first-spark.md +++ b/content/copilot/tutorials/spark/your-first-spark.md @@ -4,7 +4,7 @@ shortTitle: Your first spark intro: 'Learn how to build your first {% data variables.product.prodname_spark %} app in minutes, without writing any code.' versions: feature: spark -product: 'Anyone with a {% data variables.copilot.copilot_pro_plus_short %} license can use {% data variables.product.prodname_spark_short %}.' +product: 'Anyone with a {% data variables.copilot.copilot_pro_plus_short %} or {% data variables.copilot.copilot_enterprise_short %} license can use {% data variables.product.prodname_spark_short %}.' redirect_from: - /copilot/tutorials/building-your-first-app-in-minutes-with-github-spark - /copilot/tutorials/spark/easy-apps-with-spark @@ -57,22 +57,23 @@ Please prevent users from entering words longer than the number of rows or colum ## Sharing your app -Now that you're happy with your app, let's deploy it so you can share it with others. +Now that you're happy with your app, let's publish it so you can share it with others. You can also choose to share your spark as **read-only** so that other users can view your app's content, but they cannot edit content, delete files or records, or create new items. > [!NOTE] -> * If you make your spark accessible to all {% data variables.product.github %} users, all users will be able to access and edit the data stored in your spark. Make sure to delete any private or sensitive data from your app prior to making it visible to other users. -> * You can also choose to share your spark as **read-only** so that other users can view your app's content, but they cannot edit content, delete files or records, or create new items. +> * If you make your spark accessible to all {% data variables.product.github %} users, all users will be able to access and edit the data stored in your spark. Make sure to delete any private or sensitive data from your app prior to making it visible to other users. **This option is not available for {% data variables.enterprise.prodname_managed_users %}** 1. In the top-right corner of the page, click **Publish**. -1. By default, your spark is deployed as private and only accessible to you. To let other {% data variables.product.github %} users access your app, in the **Visibility** section of the publication dropdown, choose {% octicon "id-badge" aria-hidden="true" aria-label="id-badge" %} **All {% data variables.product.github %} users**. This allows anyone with a {% data variables.product.github %} account to access your spark. +1. By default, your spark is published as private and only accessible to you. To let other {% data variables.product.github %} users access your app, in the **Visibility** section of the publish dropdown, choose **Organization** to make your spark accessible to all members of your selected organization, or {% octicon "id-badge" aria-hidden="true" aria-label="id-badge" %} **All {% data variables.product.github %} users**. This allows anyone with a {% data variables.product.github %} account to access your spark.  -1. In the **Data Access** section of the publication dropdown, choose whether you want to give other users read-only or write access to your app. +1. If you make your spark visible to other users (i.e. any setting besides private), a "Data Access" option appears in the publication dropdown. This gives you the option to control who has access to edit the content and data in your spark. - Choose **read-only** to let others view your app, without allowing them to create, edit or delete content. +  - For example, if you've created a family calendar app and you want to showcase the app, but you don't want users to be able to create, edit or delete events in the calendar yet, choose **read-only**. + Choose **{% octicon "eye" aria-hidden="true" aria-label="eye" %} Read-Only** to let others view your app, without allowing them to create, edit or delete content or data. Choose **{% octicon "pencil" aria-hidden="true" aria-label="pencil" %} Write Access** to allow users to both edit and view content and data in your spark. + + For example, if you've created a family calendar app and you want to showcase the app, but you don't want users to be able to create, edit or delete events in the calendar yet, choose "Read-Only". 1. Click **View site** {% octicon "link-external" aria-hidden="true" aria-label="link-external" %} to see your deployed app, then copy and share your app's URL. diff --git a/data/reusables/actions/supported-github-runners.md b/data/reusables/actions/supported-github-runners.md index cf52673aa66e..29316ce00b60 100644 --- a/data/reusables/actions/supported-github-runners.md +++ b/data/reusables/actions/supported-github-runners.md @@ -33,7 +33,7 @@ For public repositories, jobs using the workflow labels shown in the table below
windows-latest,
+ windows-latest,
windows-2025,
windows-2022
windows-latest,
+ windows-latest,
windows-2025,
windows-2022
Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
OK
" } - ] + ], + "descriptionHTML": "Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Conflict when visibility type not set to selected
" } - ] + ], + "descriptionHTML": "Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Resource not found
" } - ] + ], + "descriptionHTML": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Gets a specific variable in a repository.
\nThe authenticated user must have collaborator access to the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a specific variable in a repository.
\nThe authenticated user must have collaborator access to the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Deletes a specific workflow run.
\nAnyone with write access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Deletes a specific workflow run.
\nAnyone with write access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Anyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
OK
" } - ] + ], + "descriptionHTML": "Anyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nOAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nOAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", @@ -127437,7 +127436,8 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ] + ], + "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
" }, { "serverUrl": "https://api.github.com", @@ -181393,7 +181393,6 @@ } ], "previews": [], - "descriptionHTML": "Sets a code security configuration as a default to be applied to new repositories in your enterprise.
\nThis configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set.
\nThe authenticated user must be an administrator for the enterprise to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Resource not found
" } - ] + ], + "descriptionHTML": "Sets a code security configuration as a default to be applied to new repositories in your enterprise.
\nThis configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set.
\nThe authenticated user must be an administrator for the enterprise to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Gets information about an export of a codespace.
\nOAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.
Resource not found
" } - ] + ], + "descriptionHTML": "Gets information about an export of a codespace.
\nOAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.
Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Get the content of a gitignore template.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw .gitignore contents.Not modified
" } - ] + ], + "descriptionHTML": "Get the content of a gitignore template.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw .gitignore contents.Removes one or more assignees from an issue.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Removes one or more assignees from an issue.
" }, { "serverUrl": "https://api.github.com", @@ -401706,13 +401706,13 @@ } ], "previews": [], - "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
" }, { "serverUrl": "https://api.github.com", @@ -422311,13 +422311,13 @@ } ], "previews": [], - "descriptionHTML": "Get API request count statistics for an actor broken down by route within a specified time frame.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Get API request count statistics for an actor broken down by route within a specified time frame.
" }, { "serverUrl": "https://api.github.com", @@ -432693,13 +432693,13 @@ } ], "previews": [], - "descriptionHTML": "Gets a hosted compute network settings resource configured for an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a hosted compute network settings resource configured for an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.
Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"
OAuth app tokens and personal access tokens (classic) need the read:packages and delete:packages scopes to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
Resource not found
" } - ] + ], + "descriptionHTML": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"
OAuth app tokens and personal access tokens (classic) need the read:packages and delete:packages scopes to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.OK
" } - ] + ], + "descriptionHTML": "Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Resource not found
" } - ] + ], + "descriptionHTML": "Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Lists all reviews for a specified pull request. The list of reviews returns in chronological order.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.The list of reviews returns in chronological order.
" } - ] + ], + "descriptionHTML": "Lists all reviews for a specified pull request. The list of reviews returns in chronological order.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Note
\n\nAccessing this endpoint does not count against your REST API rate limit.
\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:
core object provides your rate limit status for all non-search-related resources in the REST API.search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"Note
\n\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
Resource not found
" } - ] + ], + "descriptionHTML": "Note
\n\nAccessing this endpoint does not count against your REST API rate limit.
\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:
core object provides your rate limit status for all non-search-related resources in the REST API.search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"Note
\n\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint.Response if you upload an asset with the same filename as another uploaded asset
" } - ] + ], + "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint.Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"Privately reporting a security vulnerability.\"
", "statusCodes": [ { "httpStatusCode": "204", @@ -596937,7 +596936,8 @@ "httpStatusCode": "422", "description": "Bad Request
" } - ] + ], + "descriptionHTML": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"Privately reporting a security vulnerability.\"
" }, { "serverUrl": "https://api.github.com", @@ -598978,7 +598978,6 @@ } ], "previews": [], - "descriptionHTML": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -598988,7 +598987,8 @@ "httpStatusCode": "404", "description": "Not Found if repository is not enabled with vulnerability alerts
" } - ] + ], + "descriptionHTML": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".
" }, { "serverUrl": "https://api.github.com", @@ -599110,13 +599110,13 @@ } ], "previews": [], - "descriptionHTML": "Disables dependency alerts and the dependency graph for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"About security alerts for vulnerable dependencies\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "Disables dependency alerts and the dependency graph for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"About security alerts for vulnerable dependencies\".
" }, { "serverUrl": "https://api.github.com", @@ -612498,7 +612498,6 @@ } ], "previews": [], - "descriptionHTML": "This deletes a single autolink reference by ID that was configured for the given repository.
\nInformation about autolinks are only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "204", @@ -612508,7 +612507,8 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ] + ], + "descriptionHTML": "This deletes a single autolink reference by ID that was configured for the given repository.
\nInformation about autolinks are only available to repository administrators.
" } ], "contents": [ @@ -688668,13 +688668,13 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
" }, { "serverUrl": "https://api.github.com", @@ -693134,13 +693134,13 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.
\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.
Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.
OK
" } - ] + ], + "descriptionHTML": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.
\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.
Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.
Lists the GPG keys for a user. This information is accessible by anyone.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Lists the GPG keys for a user. This information is accessible by anyone.
" } ], "keys": [ diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index bb57ef4a2429..52397aa3afe9 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -7784,13 +7784,13 @@ } ], "previews": [], - "descriptionHTML": "Sets the actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Sets the actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"
If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings and reusable workflows settings.
To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"
If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings and reusable workflows settings.
To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists all environment variables.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists all environment variables.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Cloud as done: https://github.com/notifications.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No content
" } - ] + ], + "descriptionHTML": "Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Cloud as done: https://github.com/notifications.
" }, { "serverUrl": "https://api.github.com", @@ -92642,13 +92642,13 @@ } ], "previews": [], - "descriptionHTML": "Lists all notifications for the current user in the specified repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Lists all notifications for the current user in the specified repository.
" }, { "serverUrl": "https://api.github.com", @@ -98300,13 +98300,13 @@ } ], "previews": [], - "descriptionHTML": "Lists repositories a user has starred.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.star+json: Includes a timestamp of when the star was created.OK
" } - ] + ], + "descriptionHTML": "Lists repositories a user has starred.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.star+json: Includes a timestamp of when the star was created.Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "https://api.github.com", @@ -276562,13 +276562,13 @@ } ], "previews": [], - "descriptionHTML": "Gets a single organization secret without revealing its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a single organization secret without revealing its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Deletes a secret in an organization using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Deletes a secret in an organization using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"
\nFor more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
List of deployment protection rules
" } - ] + ], + "descriptionHTML": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"
\nFor more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Creates a hosted compute network configuration for an enterprise.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } - ] + ], + "descriptionHTML": "Creates a hosted compute network configuration for an enterprise.
" }, { "serverUrl": "https://api.github.com", @@ -442401,13 +442401,13 @@ } ], "previews": [], - "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
" }, { "serverUrl": "https://api.github.com", @@ -443335,13 +443335,13 @@ } ], "previews": [], - "descriptionHTML": "Returns all community profile metrics for a repository. The repository cannot be a fork.
\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,\nREADME, and CONTRIBUTING files.
\nThe health_percentage score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"About community profiles for public repositories.\"
content_reports_enabled is only returned for organization-owned repositories.
OK
" } - ] + ], + "descriptionHTML": "Returns all community profile metrics for a repository. The repository cannot be a fork.
\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,\nREADME, and CONTRIBUTING files.
\nThe health_percentage score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"About community profiles for public repositories.\"
content_reports_enabled is only returned for organization-owned repositories.
You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } - ] + ], + "descriptionHTML": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
" }, { "serverUrl": "https://api.github.com", @@ -596299,13 +596299,13 @@ } ], "previews": [], - "descriptionHTML": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.
" }, { "serverUrl": "https://api.github.com", @@ -613494,13 +613494,13 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
" }, { "serverUrl": "https://api.github.com", @@ -763393,13 +763393,13 @@ } ], "previews": [], - "descriptionHTML": "Lists the people who the specified user follows.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Lists the people who the specified user follows.
" }, { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/ghes-3.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json index a3ebe7ced0f4..1b66c7923f9a 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json @@ -2246,6 +2246,7 @@ } ], "previews": [], + "descriptionHTML": "Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Resource not found
" } - ], - "descriptionHTML": "Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Success response
" } - ], - "descriptionHTML": "Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Adds a self-hosted runner to a runner group configured in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Adds a self-hosted runner to a runner group configured in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Adds custom labels to a self-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "Adds custom labels to a self-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Creates an organization variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Response when creating a variable
" } - ], - "descriptionHTML": "Creates an organization variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nResource not found
" } - ], - "descriptionHTML": "Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nGets the announcement banner currently set for the organization. Only returns the announcement banner set at the\norganization level. Organization members may also see an enterprise-level announcement banner. To get an\nannouncement banner displayed at the enterprise level, use the enterprise-level endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the\norganization level. Organization members may also see an enterprise-level announcement banner. To get an\nannouncement banner displayed at the enterprise level, use the enterprise-level endpoint.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -123888,6 +123888,7 @@ } ], "previews": [], + "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", @@ -123897,8 +123898,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -171665,13 +171665,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -212752,13 +212752,13 @@ } ], "previews": [], + "descriptionHTML": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.
Created
" } - ], - "descriptionHTML": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.
OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -217759,13 +217759,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "" + ] } ], "repo-pre-receive-hooks": [ @@ -223951,13 +223951,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -343079,6 +343079,7 @@ } ], "previews": [], + "descriptionHTML": "Lists all organizations, in the order that they were created.
\nNote
\n\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Not modified
" } - ], - "descriptionHTML": "Lists all organizations, in the order that they were created.
\nNote
\n\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Deletes an organization and all its repositories.
\nThe organization login will be unavailable for 90 days after deletion.
\nPlease review the Terms of Service regarding account deletion before using this endpoint:
\nhttps://docs.github.com/enterprise-server@3.15/site-policy/github-terms/github-terms-of-service
", "statusCodes": [ { "httpStatusCode": "202", @@ -344619,8 +344620,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Deletes an organization and all its repositories.
\nThe organization login will be unavailable for 90 days after deletion.
\nPlease review the Terms of Service regarding account deletion before using this endpoint:
\nhttps://docs.github.com/enterprise-server@3.15/site-policy/github-terms/github-terms-of-service
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -350141,6 +350141,7 @@ } ], "previews": [], + "descriptionHTML": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
", "statusCodes": [ { "httpStatusCode": "200", @@ -350150,8 +350151,7 @@ "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -384688,6 +384688,7 @@ } ], "previews": [], + "descriptionHTML": "Deletes a GitHub Enterprise Server Pages site. For more information, see \"About GitHub Pages.
\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "Deletes a GitHub Enterprise Server Pages site. For more information, see \"About GitHub Pages.
\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nForbidden
" } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nUsers with push access to the repository can create a release.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
", "statusCodes": [ { "httpStatusCode": "201", @@ -443372,8 +443373,7 @@ "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "Users with push access to the repository can create a release.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -447522,13 +447522,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -504761,6 +504761,7 @@ } ], "previews": [], + "descriptionHTML": "Find commits via various criteria on the default branch (usually main). This method returns up to 100 results per page.
When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.
For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:
\nq=repo:octocat/Spoon-Knife+css
Not modified
" } - ], - "descriptionHTML": "Find commits via various criteria on the default branch (usually main). This method returns up to 100 results per page.
When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.
For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:
\nq=repo:octocat/Spoon-Knife+css
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Provides publicly available information about someone with a GitHub account.
\nThe email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.
The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.
", "statusCodes": [ { "httpStatusCode": "200", @@ -546033,8 +546034,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Provides publicly available information about someone with a GitHub account.
\nThe email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.
The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -549917,13 +549917,13 @@ } ], "previews": [], + "descriptionHTML": "Lists the verified public SSH keys for a user. This is accessible by anyone.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists the verified public SSH keys for a user. This is accessible by anyone.
" + ] } ], "social-accounts": [