diff --git a/CHANGELOG.md b/CHANGELOG.md index dbeddafa8930..467b1b3c39e3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,16 @@ # Docs changelog +**9 April 2026** + +We have added documentation for the code security risk assessment (CSRA), a free self-serve tool that helps organization admins and security managers understand their organization's exposure to code vulnerabilities. +New content includes: + +* [Code security risk assessment](https://docs.github.com/en/code-security/concepts/code-scanning/code-security-risk-assessment): What the CSRA is, who can run it, what it scans, and how it relates to the secret risk assessment. +* [Running a code security risk assessment](https://docs.github.com/en/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/assess-your-vulnerability-risk): How to generate and rerun a CSRA report. +* [Interpreting code security risk assessment results](https://docs.github.com/en/code-security/tutorials/secure-your-organization/interpreting-code-security-risk-assessment-results): How to read the results dashboard, understand vulnerability and rule breakdowns, and enable Code Security directly from the assessment. + +
+ **3 April 2026** We've published documentation for the GitHub Copilot SDK, now available in public preview. These docs were migrated from the `github/copilot-sdk` repo and cover getting started, setup, authentication, usage patterns, hooks, observability, integrations, and troubleshooting. @@ -102,7 +113,7 @@ We've added an article about the new `/research` slash command in Copilot CLI: **27 February 2026** -We've extended the reference information for Copilot CLI, adding much more detail. See [GitHub Copilot CLI command reference](https://docs.github.com/copilot/reference/cli-command-reference#custom-agents-reference). +We've extended the reference information for Copilot CLI, adding much more detail. See [GitHub Copilot CLI command reference](https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference#custom-agents-reference).
@@ -114,7 +125,7 @@ We've added many new articles to coincide with the [general availability release * [New conceptual articles](https://docs.github.com/copilot/concepts/agents/copilot-cli) explaining plugins, autopilot mode, the `/fleet` slash command, and a comparison of CLI features. * New how-to articles on [setting up](https://docs.github.com/copilot/how-tos/copilot-cli/set-up-copilot-cli) and [customizing](https://docs.github.com/copilot/how-tos/copilot-cli/customize-copilot) the CLI. * An article on [administering Copilot CLI for your enterprise](https://docs.github.com/copilot/how-tos/copilot-cli/administer-copilot-cli-for-your-enterprise). -* More reference information about [commands](https://docs.github.com/copilot/reference/cli-command-reference) and [plugins](https://docs.github.com/copilot/reference/cli-plugin-reference). +* More reference information about [commands](https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference) and [plugins](https://docs.github.com/copilot/reference/copilot-cli-reference/cli-plugin-reference).
@@ -140,11 +151,11 @@ We've published a new tutorial on [using GitHub Copilot coding agent to improve **20 January 2026** -We published the first iteration of the [GitHub Copilot feature matrix](https://docs.github.com/copilot/reference/copilot-feature-matrix) to provide customers with the latest information about which Copilot features are available by which IDE/version. +We published the first iteration of the [GitHub Copilot feature matrix](https://docs.github.com/copilot/reference/copilot-feature-matrix) to provide customers with the latest information about which Copilot features are available by which IDE/version. Historically, keeping Copilot feature and IDE availability up to date has required manual coordination with the Docs team, which does not scale well with the increasing number of features. The goal of this document and its process is to enable product owners to directly maintain the Copilot feature and IDE availability information as part of their normal release workflow. The feature matrix provides a single, easy to update source of truth. -The feature matrix is in public preview so that customers have time to gather and submit feedback to us. +The feature matrix is in public preview so that customers have time to gather and submit feedback to us.
@@ -221,7 +232,7 @@ You can also now add files to a Copilot Space directly from the code view on Git **25 November 2025** -We've added details of files that are excluded from Copilot code reviews. +We've added details of files that are excluded from Copilot code reviews. See [About GitHub Copilot code review](https://docs.github.com/copilot/concepts/agents/code-review#excluded-files). @@ -229,7 +240,7 @@ See [About GitHub Copilot code review](https://docs.github.com/copilot/concepts/ **24 November 2025** -We've added a new tutorial on burning down technical debt in a project: +We've added a new tutorial on burning down technical debt in a project: [Using GitHub Copilot to reduce technical debt](https://docs.github.com/copilot/tutorials/reduce-technical-debt) @@ -396,17 +407,17 @@ We’ve updated the Spark documentation to support the launch for Copilot Enterp **29 September 2025** -Claude Sonnet 4.5 has been released as a Public Preview. At the time of launch, it will be available on the following platforms: +Claude Sonnet 4.5 has been released as a Public Preview. At the time of launch, it will be available on the following platforms: -- **Copilot Chat** +- **Copilot Chat** - Released for GitHub.com, VS Code, GitHub Mobile - With: Copilot Pro, Pro+, Business, and Enterprise - **Copilot Coding Agent** - - With: Copilot Pro, and Copilot Pro+ + - With: Copilot Pro, and Copilot Pro+ - **Copilot CLI** - With: Copilot Pro, Pro+, Business, and Enterprise -The following articles have been updated: +The following articles have been updated: - [About GitHub Copilot coding agent](https://docs.github.com/copilot/concepts/agents/coding-agent/about-coding-agent) - [Supported AI models in GitHub Copilot](https://docs.github.com/copilot/reference/ai-models/supported-models) @@ -441,9 +452,9 @@ See: **25 September 2025** -We've updated the documentation for the GA release of [Copilot Spaces](https://github.com/copilot/spaces). Spaces allow you to organize and centralize content and resources in order to ground Copilot Chat's responses in that context and share knowledge across teams. You can now also access Copilot Spaces in your IDE via the GitHub MCP server. +We've updated the documentation for the GA release of [Copilot Spaces](https://github.com/copilot/spaces). Spaces allow you to organize and centralize content and resources in order to ground Copilot Chat's responses in that context and share knowledge across teams. You can now also access Copilot Spaces in your IDE via the GitHub MCP server. -See the updated docs: +See the updated docs: * [About organizing and sharing context with GitHub Copilot Spaces](https://docs.github.com/copilot/concepts/context/spaces) * [Creating GitHub Copilot Spaces](https://docs.github.com/copilot/how-tos/provide-context/use-copilot-spaces/create-copilot-spaces) * [Using GitHub Copilot Spaces](https://docs.github.com/copilot/how-tos/provide-context/use-copilot-spaces/use-copilot-spaces) @@ -452,15 +463,15 @@ See the updated docs: **24 September 2025** -Until now, assigning Copilot coding agent to an issue was limited to the same repository as the issue. +Until now, assigning Copilot coding agent to an issue was limited to the same repository as the issue. + +You can now: -You can now: +* Assign Copilot coding agent to work in a different repository, supporting workflows where issues and code files are managed separately. +* Provide additional instructions to tailor the agent's output to your requirements. +* Choose the base branch for the agent to use. -* Assign Copilot coding agent to work in a different repository, supporting workflows where issues and code files are managed separately. -* Provide additional instructions to tailor the agent's output to your requirements. -* Choose the base branch for the agent to use. - -These changes provide a more flexible, transparent, and user-friendly experience for managing automated coding tasks with Copilot coding agent. +These changes provide a more flexible, transparent, and user-friendly experience for managing automated coding tasks with Copilot coding agent. See the updated docs: [Using GitHub Copilot to work on an issue](https://docs.github.com/copilot/how-tos/use-copilot-agents/coding-agent/assign-copilot-to-an-issue#assigning-an-issue-to-copilot). @@ -487,9 +498,9 @@ See [About the GitHub MCP Registry](https://docs.github.com/copilot/concepts/con **17 September 2025** -We've added documentation for expanded features for reusing workflow configurations in GitHub Actions. +We've added documentation for expanded features for reusing workflow configurations in GitHub Actions. -You can now use YAML anchors and aliases to reuse pieces of content in a workflow. See [YAML anchors and aliases](https://docs.github.com/actions/concepts/workflows-and-actions/reusing-workflow-configurations#yaml-anchors-and-aliases). +You can now use YAML anchors and aliases to reuse pieces of content in a workflow. See [YAML anchors and aliases](https://docs.github.com/actions/concepts/workflows-and-actions/reusing-workflow-configurations#yaml-anchors-and-aliases). To keep the content focused on users' job-to-be-done, we simplified the procedures for [creating workflow templates for your organization](https://docs.github.com/actions/how-tos/reuse-automations/create-workflow-templates). In addition, we updated reference documentation for workflow templates with details on permissions, repository visibility rules, rules for the metadata file, and examples. See [Workflow templates](https://docs.github.com/actions/reference/workflows-and-actions/reusing-workflow-configurations#workflow-templates). @@ -497,7 +508,7 @@ To keep the content focused on users' job-to-be-done, we simplified the procedur **17 September 2025** -You can now publish your Spark app as "read-only." +You can now publish your Spark app as "read-only." By default, data stored in Spark is shared across all users of the app. You can choose to publish your app as "read-only" if you want to showcase your app to others, but you don't want others to be able to edit or delete any stored data. @@ -610,7 +621,7 @@ See [Working with push protection and the GitHub MCP server](https://docs.github **12 August 2025** -OpenAI GPT-5 is now available in public preview for GitHub Copilot. GPT-5 is slowly rolling out to all paid Copilot plans and you will be able to access the model in GitHub Copilot Chat on github.com and Visual Studio Code (Agent, Ask, and Edit modes). +OpenAI GPT-5 is now available in public preview for GitHub Copilot. GPT-5 is slowly rolling out to all paid Copilot plans and you will be able to access the model in GitHub Copilot Chat on github.com and Visual Studio Code (Agent, Ask, and Edit modes). See [Supported AI models in Copilot](https://docs.github.com/copilot/reference/ai-models/supported-models). @@ -632,7 +643,7 @@ We have added a tutorial for using Copilot to create Mermaid diagrams at [Creati **4 August 2025** -To address common pain points that developers face when remediating a leaked secret, we created a new article, "[Remediating a leaked secret](https://docs.github.com/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/remediating-a-leaked-secret)". +To address common pain points that developers face when remediating a leaked secret, we created a new article, "[Remediating a leaked secret](https://docs.github.com/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/remediating-a-leaked-secret)". The new guide incorporates cross-platform GitHub tools, as well as opinionated guidance from GitHub's secret scanning team, to walk the developer through a thorough remediation process. diff --git a/assets/images/help/copilot/copilot-cli-context-usage.png b/assets/images/help/copilot/copilot-cli-context-usage.png new file mode 100644 index 000000000000..451a7a6eb70d Binary files /dev/null and b/assets/images/help/copilot/copilot-cli-context-usage.png differ diff --git a/content/code-security/concepts/supply-chain-security/immutable-releases.md b/content/code-security/concepts/supply-chain-security/immutable-releases.md index 4474d35c7fbb..12cbdaa97cab 100644 --- a/content/code-security/concepts/supply-chain-security/immutable-releases.md +++ b/content/code-security/concepts/supply-chain-security/immutable-releases.md @@ -18,7 +18,7 @@ category: When you enable immutable releases, the following protections are enforced: -* **Git tags cannot be moved or deleted**: Once an immutable release is published, its associated Git tag is locked to a specific commit and cannot be changed or removed. +* **Git tags cannot be moved**: Once an immutable release is published, its associated Git tag is locked to a specific commit, cannot be changed, and cannot be deleted while the release exists. If you delete the immutable release, you can delete the tag, but you cannot reuse the same tag name. * **Release assets cannot be modified or deleted**: All files attached to the release (such as binaries and archives) are protected from modification or deletion. Additionally, creating an immutable release automatically generates a **release attestation**, which is a cryptographically verifiable record of a release containing the release tag, commit SHA, and release assets. Consumers can use this attestation to make sure the releases and artifacts they are using exactly match the published {% data variables.product.github %} releases. diff --git a/content/copilot/concepts/agents/copilot-cli/chronicle.md b/content/copilot/concepts/agents/copilot-cli/chronicle.md index 8d6b2f5480c6..66376166ea59 100644 --- a/content/copilot/concepts/agents/copilot-cli/chronicle.md +++ b/content/copilot/concepts/agents/copilot-cli/chronicle.md @@ -93,4 +93,4 @@ To reindex the session store, use the following slash command in an interactive ## Further reading * [AUTOTITLE](/copilot/how-tos/copilot-cli/chronicle) -* [AUTOTITLE](/copilot/reference/cli-command-reference) +* [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-command-reference) diff --git a/content/copilot/concepts/agents/copilot-cli/context-management.md b/content/copilot/concepts/agents/copilot-cli/context-management.md new file mode 100644 index 000000000000..5894159630e3 --- /dev/null +++ b/content/copilot/concepts/agents/copilot-cli/context-management.md @@ -0,0 +1,145 @@ +--- +title: Managing context in {% data variables.copilot.copilot_cli %} +shortTitle: Context management +allowTitleToDifferFromFilename: true +intro: 'Understand how {% data variables.product.prodname_copilot_short %} manages conversation context, what happens during long sessions, and how to stay in control of your context window.' +versions: + feature: copilot +contentType: concepts +category: + - Learn about Copilot # Copilot discovery page + - Learn about Copilot CLI # Copilot CLI bespoke page +docsTeamMetrics: + - copilot-cli +--- + +## About the context window + +When you use {% data variables.copilot.copilot_cli %}, every message you send, every response from {% data variables.product.prodname_copilot_short %}, every tool call and its result, and the system instructions that define {% data variables.product.prodname_copilot_short %}'s behavior are all held in a **context window**. The context window is the total amount of information that the AI model can consider at one time when generating a response. + +The context window has a fixed size, measured in tokens, that varies by model. Tokens typically consist of short, commonly used words, and fragments of multi-syllable words. As your conversation progresses, the context window fills up with: + +* **System instructions and tool definitions**: The built-in instructions that tell {% data variables.product.prodname_copilot_short %} how to behave, plus the schemas of all available tools. These are always present and take up a fixed portion of the context window. +* **Your messages**: Every prompt you send. +* **{% data variables.product.prodname_copilot_short %}'s responses**: Everything {% data variables.product.prodname_copilot_short %} says back to you. +* **Tool calls and results**: When {% data variables.product.prodname_copilot_short %} reads files, runs commands, or searches your codebase, both the request and the output are added to the context. Tool results can be especially large—for example, if a tool reads a long file or runs a command that produces extensive output. + +All of this accumulates in the context window. In a long or complex session, the context window can fill up. + +### Why the context window matters + +The context window is what gives {% data variables.product.prodname_copilot_short %} its "memory" of your conversation. Everything inside the context window is available for {% data variables.product.prodname_copilot_short %} to reference when responding to you. + +This means that in a very long session, {% data variables.product.prodname_copilot_short %} might not be able to hold the entire conversation history at once. {% data variables.copilot.copilot_cli_short %} therefore has context management features that effectively allow you to continue a conversation with {% data variables.product.prodname_copilot_short %} for as long as you need. + +## Checking your context usage + +You can check how much of the context window is currently in use by entering the `/context` slash command. This displays a visual breakdown of your token usage, showing: + +* **System/Tools**: The fixed overhead of system instructions and tool definitions. +* **Messages**: The space used by your conversation history. +* **Free Space**: How much room is left for new messages. +* **Buffer**: A reserved portion that triggers automatic context management. + +![Screenshot of the output of the '/context' CLI command.](/assets/images/help/copilot/copilot-cli-context-usage.png) + +You might want to use the `/context` slash command when: + +* You're in a long session and want to know how much space is left. +* {% data variables.product.prodname_copilot_short %} seems to be forgetting earlier parts of the conversation. +* You want to understand whether compaction has occurred, or is likely to occur soon. + +## Compaction + +Compaction is the process that allows {% data variables.copilot.copilot_cli %} to support long-running sessions without hitting the limits of the context window. + +### When compaction happens + +When your conversation reaches approximately 80% of the context window's capacity, {% data variables.copilot.copilot_cli_short %} automatically starts compacting the context in the background. This leaves a buffer of approximately 20% so that tool calls can continue to run while compaction is in progress. If the context fills to approximately 95% before compaction finishes, {% data variables.copilot.copilot_cli_short %} pauses briefly to wait for compaction to complete before continuing. + +You can also trigger compaction manually at any time by entering the `/compact` command. This is useful if you're about to start a new phase of work and want to free up context space proactively. Press Esc to cancel a manual compaction if you change your mind. + +### What compaction does + +When compaction runs, {% data variables.copilot.copilot_cli_short %}: + +1. Takes a snapshot of the current conversation history. +1. Sends the full conversation to the AI model with a special prompt that asks it to generate a structured summary. The summary captures the goals of the conversation, what was done, key technical details, important files, and planned next steps. +1. Replaces the old conversation history with the summary, along with any original user instructions and the current state of any plans or to-do lists. +1. Keeps any messages that were added while compaction was running in the background. + +The result is that the conversation history is compressed into a much smaller summary, freeing up the majority of the context window for new work. {% data variables.product.prodname_copilot_short %} uses this summary to maintain continuity—it knows what was discussed, what was decided, and what to do next—even though the original messages have been replaced. + +### What compaction does not preserve + +Compaction is a summarization process, so some detail is inevitably lost. The summary captures the key points, but fine-grained details—such as the exact wording of every message, the full output of every command, or minor decisions made early in a long conversation—may not be included. If you need {% data variables.product.prodname_copilot_short %} to recall a very specific detail from much earlier in the session, it may not have that information after compaction. + +### What would happen without compaction + +Without compaction, once the context window filled up, {% data variables.product.prodname_copilot_short %} would have to fall back to simply dropping old messages from the conversation history—removing them without any summary or record. This would mean losing context abruptly, with no way for {% data variables.product.prodname_copilot_short %} to know what was in the deleted messages. Compaction avoids this by replacing the history with an intelligent summary rather than discarding it. + +## Checkpoints + +Every time compaction happens—whether automatically or manually—a **checkpoint** is created. A checkpoint is a saved copy of the compaction summary, stored as a numbered, titled file in your session's workspace. + +### Viewing checkpoints + +To see all checkpoints in your current session, enter: + +```copilot copy +/session checkpoints +``` + +This lists every checkpoint with its number and title: + +```text +Checkpoint History (3 total): + 3. Refactoring authentication module + 2. Implementing user dashboard + 1. Initial planning and setup +``` + +Use the checkpoint number to view the full content of any checkpoint. For example, to view checkpoint 2, enter: + +```copilot copy +/session checkpoints 2 +``` + +### When checkpoints are useful + +* **Reviewing what happened**: After a long session with multiple compactions, earlier phases of the conversation are no longer in the active context. Checkpoints let you read back through what {% data variables.product.prodname_copilot_short %} did at each compaction. +* **Verifying continuity**: If you want to check that {% data variables.product.prodname_copilot_short %}'s summary accurately captured your earlier work before continuing, you can review the most recent checkpoint. +* **Debugging confusion**: If {% data variables.product.prodname_copilot_short %} seems to have forgotten a decision or is going in a direction that contradicts earlier work, checking checkpoints can reveal what was preserved during compaction and what might have been summarized differently than you expected. + +> [!NOTE] +> * Checkpoints are created automatically. You don't need to manage them—they're there if you need them. For most sessions, you won't need to look at checkpoints at all. +> * You can't reverse a compaction once it has completed. + +## Using long-running sessions + +Automatic compaction allows you to continue working in a long-running session without worrying about hitting the limits of the context window. There are times when this is very useful, and other times when you might prefer to start a fresh session. + +### When long sessions are useful + +Long-running sessions work well when: + +* You're working on a multi-phase task, such as building a feature that requires scaffolding, implementation, testing, and then creating a pull request. +* You're iterating on a problem and want {% data variables.product.prodname_copilot_short %} to retain the context of what's been tried and what hasn't worked. +* You're doing exploratory work across a codebase and building up shared understanding with {% data variables.product.prodname_copilot_short %} over time. + +### When to start a fresh session + +Starting a new session is better when: + +* You're switching to an unrelated task. {% data variables.product.prodname_copilot_short %} doesn't need the context of your previous work, and a clean context window means more space for the new task. +* The conversation has gone through many compactions, and you feel that important context is being lost in the summarization process. +* You want a clean slate—for example, if work went in a wrong direction and you'd rather start over than have {% data variables.product.prodname_copilot_short %} try to reconcile earlier decisions with a new approach. + +> [!TIP] +> You can resume previous sessions at any time using the `/resume` command. This lets you pick up where you left off, including any checkpoints that were created during that session. + +## Further reading + +* [AUTOTITLE](/copilot/how-tos/copilot-cli) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/use-copilot-cli) +* [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-command-reference) diff --git a/content/copilot/concepts/agents/copilot-cli/index.md b/content/copilot/concepts/agents/copilot-cli/index.md index 2ba42405ebb7..9a6b524ff8cd 100644 --- a/content/copilot/concepts/agents/copilot-cli/index.md +++ b/content/copilot/concepts/agents/copilot-cli/index.md @@ -14,6 +14,7 @@ children: - /fleet - /research - /chronicle + - /context-management contentType: concepts docsTeamMetrics: - copilot-cli diff --git a/content/copilot/concepts/billing/copilot-requests.md b/content/copilot/concepts/billing/copilot-requests.md index c8caa0f5f4f9..772137e4d921 100644 --- a/content/copilot/concepts/billing/copilot-requests.md +++ b/content/copilot/concepts/billing/copilot-requests.md @@ -50,7 +50,6 @@ The following {% data variables.product.prodname_copilot_short %} features can u {% endrowheaders %} - > [!TIP] > For instructions on viewing how many premium requests you have used and advice on how to optimize usage, see [AUTOTITLE](/copilot/how-tos/manage-and-track-spending/monitor-premium-requests). @@ -89,10 +88,10 @@ The available models vary depending on your {% data variables.product.prodname_c > [!NOTE] > * The models included with {% data variables.product.prodname_copilot_short %} plans are subject to change. +> * Model multipliers and costs are subject to change. > * Discounted multipliers are available for using {% data variables.copilot.copilot_auto_model_selection %} in {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_vscode_shortname %}. See [AUTOTITLE](/copilot/concepts/auto-model-selection). > * {% data reusables.copilot.auto-model-multiplier-discount %} For example, Sonnet 4 would be billed at .9x rather than 1x when using {% data variables.copilot.copilot_auto_model_selection_short %}. > * Discounted multipliers are not available for {% data variables.copilot.copilot_free_short %}. -> * The multiplier for {% data variables.copilot.copilot_claude_sonnet_46 %} may be subject to change. Each model has a premium request multiplier, based on its complexity and resource usage. If you are on a paid {% data variables.product.prodname_copilot_short %} plan, your premium request allowance is deducted according to this multiplier. diff --git a/content/copilot/how-tos/copilot-cli/allowing-tools.md b/content/copilot/how-tos/copilot-cli/allowing-tools.md index 362c0187c3d6..2aaf0886922e 100644 --- a/content/copilot/how-tos/copilot-cli/allowing-tools.md +++ b/content/copilot/how-tos/copilot-cli/allowing-tools.md @@ -47,7 +47,7 @@ copilot --excluded-tools='web_fetch, web_search' ``` > [!NOTE] -> For full details of the syntax for these and other command-line options mentioned in this article, see [AUTOTITLE](/copilot/reference/cli-command-reference#command-line-options). +> For full details of the syntax for these and other command-line options mentioned in this article, see [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-command-reference#command-line-options). ## Allowing or denying permission for specific tools @@ -72,7 +72,7 @@ Deny rules always take precedence over allow rules, even when `--allow-all` is s | `--available-tools='bash,edit,view,grep,glob' --allow-tool='shell(git:*)' --deny-tool='shell(git push)'` | Combine both layers of control for a restricted CLI session. {% data variables.product.prodname_copilot_short %} can explore the code, make edits, and commit changes, but can't reach the internet, run arbitrary subagents, or push to Git history. | -For details of the supported tool kinds, see [AUTOTITLE](/copilot/reference/cli-command-reference#tool-permission-patterns). +For details of the supported tool kinds, see [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-command-reference#tool-permission-patterns). ## Permissive options diff --git a/content/copilot/how-tos/copilot-cli/chronicle.md b/content/copilot/how-tos/copilot-cli/chronicle.md index 557a148d29a1..0e29fa991a29 100644 --- a/content/copilot/how-tos/copilot-cli/chronicle.md +++ b/content/copilot/how-tos/copilot-cli/chronicle.md @@ -193,4 +193,4 @@ Have I worked on anything related to authentication in the last month? ## Further reading * [AUTOTITLE](/copilot/concepts/agents/copilot-cli/chronicle) -* [AUTOTITLE](/copilot/reference/cli-command-reference) +* [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-command-reference) diff --git a/content/copilot/how-tos/copilot-cli/cli-best-practices.md b/content/copilot/how-tos/copilot-cli/cli-best-practices.md index 11e42282708c..f42bce9c7022 100644 --- a/content/copilot/how-tos/copilot-cli/cli-best-practices.md +++ b/content/copilot/how-tos/copilot-cli/cli-best-practices.md @@ -279,7 +279,7 @@ Visualize your current context usage with `/context`. It shows a breakdown of: * System/tools tokens * Message history tokens -* Available free space +* Free space * Buffer allocation ## 4. Delegate work effectively diff --git a/content/copilot/how-tos/copilot-cli/index.md b/content/copilot/how-tos/copilot-cli/index.md index 8ec27a764e2e..9f966eaca891 100644 --- a/content/copilot/how-tos/copilot-cli/index.md +++ b/content/copilot/how-tos/copilot-cli/index.md @@ -33,6 +33,7 @@ children: - /content/copilot/concepts/agents/copilot-cli/fleet - /content/copilot/concepts/agents/copilot-cli/research - /content/copilot/concepts/agents/copilot-cli/chronicle + - /content/copilot/concepts/agents/copilot-cli/context-management - /set-up-copilot-cli/install-copilot-cli - /set-up-copilot-cli/configure-copilot-cli - /automate-copilot-cli/quickstart diff --git a/content/copilot/reference/copilot-usage-metrics/example-schema.md b/content/copilot/reference/copilot-usage-metrics/example-schema.md index 95b4cb8bd426..4b6afdf68244 100644 --- a/content/copilot/reference/copilot-usage-metrics/example-schema.md +++ b/content/copilot/reference/copilot-usage-metrics/example-schema.md @@ -115,6 +115,7 @@ The following are example schemas for the user-level and enterprise-level data r "pull_requests" : { "median_minutes_to_merge" : 2.5, "median_minutes_to_merge_copilot_authored" : 2.5, + "median_minutes_to_merge_copilot_reviewed" : 2.5, "total_applied_suggestions" : 1, "total_copilot_applied_suggestions" : 1, "total_copilot_suggestions" : 1, @@ -122,6 +123,7 @@ The following are example schemas for the user-level and enterprise-level data r "total_created_by_copilot" : 1, "total_merged" : 2, "total_merged_created_by_copilot" : 1, + "total_merged_reviewed_by_copilot" : 1, "total_reviewed" : 1, "total_reviewed_by_copilot" : 1, "total_suggestions" : 1 @@ -199,6 +201,7 @@ The following are example schemas for the user-level and enterprise-level data r "total_created_by_copilot" : 0, "total_merged" : 0, "total_merged_created_by_copilot" : 0, + "total_merged_reviewed_by_copilot" : 0, "total_reviewed" : 1, "total_reviewed_by_copilot" : 0, "total_suggestions" : 1 diff --git a/content/copilot/responsible-use/copilot-cli.md b/content/copilot/responsible-use/copilot-cli.md index eeba31213819..d2aeaee31f5b 100644 --- a/content/copilot/responsible-use/copilot-cli.md +++ b/content/copilot/responsible-use/copilot-cli.md @@ -105,7 +105,7 @@ By default, {% data variables.copilot.copilot_cli_short %}: * Will ask for permission before modifying files. Ensure that it is modifying the correct files before granting permission. * Will ask for permission before executing commands that may be dangerous. Review these commands carefully before giving it permission to run. -You can grant {% data variables.copilot.copilot_cli_short %} specific permissions, or all permissions, by using the various command line options: for example, `--allow-tool=[TOOLS...]`, `--allow-all-tools`, `--allow-all` (or its slash command equivalent `/allow-all` for use in an interactive session). For more information, see [AUTOTITLE](/copilot/reference/cli-command-reference#command-line-options). Typically, when you use {% data variables.copilot.copilot_cli_short %} in autopilot mode, you will grant it full permissions to allow it to complete a task autonomously, without requiring you to approve activity as it works on the task. For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-cli/autopilot). +You can grant {% data variables.copilot.copilot_cli_short %} specific permissions, or all permissions, by using the various command line options: for example, `--allow-tool=[TOOLS...]`, `--allow-all-tools`, `--allow-all` (or its slash command equivalent `/allow-all` for use in an interactive session). For more information, see [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-command-reference#command-line-options). Typically, when you use {% data variables.copilot.copilot_cli_short %} in autopilot mode, you will grant it full permissions to allow it to complete a task autonomously, without requiring you to approve activity as it works on the task. For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-cli/autopilot). For more information about security practices while using {% data variables.copilot.copilot_cli %}, see "Security considerations" in [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli#security-considerations). diff --git a/data/release-notes/enterprise-server/3-20/0-rc1.yml b/data/release-notes/enterprise-server/3-20/0-rc1.yml index 86adc5d47db0..acba2a5a20fe 100644 --- a/data/release-notes/enterprise-server/3-20/0-rc1.yml +++ b/data/release-notes/enterprise-server/3-20/0-rc1.yml @@ -161,7 +161,7 @@ sections: notes: # https://github.com/github/releases/issues/6063 - | - Releases support immutability, locking release assets from being added, modified, or deleted after publication and protecting the release tag from being moved or deleted. This helps protect distributed artifacts from supply chain attacks. Release attestations are not supported on GHES and are only available on GitHub.com. + Releases support immutability, locking release assets from being added, modified, or deleted after publication. The release tag cannot be moved, and cannot be deleted while the release exists. If the release is deleted, the tag can be removed but cannot be reused. This helps protect distributed artifacts from supply chain attacks. Release attestations are not supported on GHES and are only available on GitHub.com. changes: - | diff --git a/data/release-notes/enterprise-server/3-20/0.yml b/data/release-notes/enterprise-server/3-20/0.yml index fdbae5715d68..b2f1e3af1cca 100644 --- a/data/release-notes/enterprise-server/3-20/0.yml +++ b/data/release-notes/enterprise-server/3-20/0.yml @@ -157,7 +157,7 @@ sections: notes: # https://github.com/github/releases/issues/6063 - | - Releases support immutability, locking release assets from being added, modified, or deleted after publication and protecting the release tag from being moved or deleted. This helps protect distributed artifacts from supply chain attacks. Release attestations are not supported on GHES and are only available on GitHub.com. + Releases support immutability, locking release assets from being added, modified, or deleted after publication. The release tag cannot be moved, and cannot be deleted while the release exists. If the release is deleted, the tag can be removed but cannot be reused. This helps protect distributed artifacts from supply chain attacks. Release attestations are not supported on GHES and are only available on GitHub.com. changes: - | diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 1d8fd340bc6c..57c709aa468e 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "2d6cbdb1321b97517f0af20e94eff59e89a36c25" + "sha": "36e6d2087a74bda6b56e450420eee3427798bc75" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/agent-tasks.json b/src/rest/data/fpt-2022-11-28/agent-tasks.json index 40550f3a7299..1dab325724e0 100644 --- a/src/rest/data/fpt-2022-11-28/agent-tasks.json +++ b/src/rest/data/fpt-2022-11-28/agent-tasks.json @@ -146,10 +146,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -293,26 +292,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -322,6 +320,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -433,20 +435,10 @@ } ], "bodyParameters": [ - { - "type": "integer", - "name": "agent_id", - "description": "

Agent ID (optional, defaults to coding agent)

" - }, { "type": "string", - "name": "problem_statement", - "description": "

Additional prompting for the agent

" - }, - { - "type": "string", - "name": "event_content", - "description": "

User's written prompt

", + "name": "prompt", + "description": "

The user's prompt for the agent

", "isRequired": true }, { @@ -454,15 +446,11 @@ "name": "model", "description": "

The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: claude-sonnet-4.6, claude-opus-4.6, gpt-5.2-codex, gpt-5.3-codex, gpt-5.4, claude-sonnet-4.5, claude-opus-4.5

" }, - { - "type": "string", - "name": "custom_agent", - "description": "

Custom agent identifier

" - }, { "type": "boolean", "name": "create_pull_request", - "description": "

Whether to create a PR

" + "description": "

Whether to create a PR.

", + "default": false }, { "type": "string", @@ -470,7 +458,7 @@ "description": "

Base ref for new branch/PR

" } ], - "descriptionHTML": "

Note

\n

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

\n
\n

Creates a new task for a repository

", + "descriptionHTML": "

Note

\n

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

\n
\n

Creates a new task for a repository.

", "codeExamples": [ { "request": { @@ -478,8 +466,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "event_content": "Fix the login button on the homepage", - "create_pull_request": true, + "prompt": "Fix the login button on the homepage", "base_ref": "main" }, "parameters": { @@ -639,26 +626,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -668,6 +654,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -806,10 +796,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -834,9 +823,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] }, @@ -968,26 +958,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -997,6 +986,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1090,15 +1083,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -1132,47 +1116,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -1181,20 +1128,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", @@ -1358,10 +1295,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1505,26 +1441,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1534,6 +1469,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1666,10 +1605,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1694,9 +1632,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] }, @@ -1828,26 +1767,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1857,6 +1795,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1950,15 +1892,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -1992,47 +1925,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -2041,20 +1937,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", diff --git a/src/rest/data/fpt-2022-11-28/gists.json b/src/rest/data/fpt-2022-11-28/gists.json index 5753b16e2b56..ced57c43e2b7 100644 --- a/src/rest/data/fpt-2022-11-28/gists.json +++ b/src/rest/data/fpt-2022-11-28/gists.json @@ -2616,7 +2616,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -3768,7 +3768,7 @@ ] } ], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -9157,7 +9157,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -10785,7 +10785,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11062,7 +11062,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11344,7 +11344,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11627,7 +11627,7 @@ "isRequired": true } ], - "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { diff --git a/src/rest/data/fpt-2022-11-28/secret-scanning.json b/src/rest/data/fpt-2022-11-28/secret-scanning.json index 35929386ce77..5fe5e5e2aaae 100644 --- a/src/rest/data/fpt-2022-11-28/secret-scanning.json +++ b/src/rest/data/fpt-2022-11-28/secret-scanning.json @@ -48,6 +48,24 @@ "type": "string" } }, + { + "name": "exclude_providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.

", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.

", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "resolution", "in": "query", @@ -571,6 +589,20 @@ "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -1910,6 +1942,24 @@ "type": "string" } }, + { + "name": "exclude_providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.

", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.

", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "resolution", "in": "query", @@ -2374,6 +2424,20 @@ "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -3581,6 +3645,20 @@ "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -4857,6 +4935,20 @@ "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." diff --git a/src/rest/data/fpt-2026-03-10/agent-tasks.json b/src/rest/data/fpt-2026-03-10/agent-tasks.json index 40550f3a7299..1dab325724e0 100644 --- a/src/rest/data/fpt-2026-03-10/agent-tasks.json +++ b/src/rest/data/fpt-2026-03-10/agent-tasks.json @@ -146,10 +146,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -293,26 +292,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -322,6 +320,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -433,20 +435,10 @@ } ], "bodyParameters": [ - { - "type": "integer", - "name": "agent_id", - "description": "

Agent ID (optional, defaults to coding agent)

" - }, { "type": "string", - "name": "problem_statement", - "description": "

Additional prompting for the agent

" - }, - { - "type": "string", - "name": "event_content", - "description": "

User's written prompt

", + "name": "prompt", + "description": "

The user's prompt for the agent

", "isRequired": true }, { @@ -454,15 +446,11 @@ "name": "model", "description": "

The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: claude-sonnet-4.6, claude-opus-4.6, gpt-5.2-codex, gpt-5.3-codex, gpt-5.4, claude-sonnet-4.5, claude-opus-4.5

" }, - { - "type": "string", - "name": "custom_agent", - "description": "

Custom agent identifier

" - }, { "type": "boolean", "name": "create_pull_request", - "description": "

Whether to create a PR

" + "description": "

Whether to create a PR.

", + "default": false }, { "type": "string", @@ -470,7 +458,7 @@ "description": "

Base ref for new branch/PR

" } ], - "descriptionHTML": "

Note

\n

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

\n
\n

Creates a new task for a repository

", + "descriptionHTML": "

Note

\n

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

\n
\n

Creates a new task for a repository.

", "codeExamples": [ { "request": { @@ -478,8 +466,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "event_content": "Fix the login button on the homepage", - "create_pull_request": true, + "prompt": "Fix the login button on the homepage", "base_ref": "main" }, "parameters": { @@ -639,26 +626,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -668,6 +654,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -806,10 +796,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -834,9 +823,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] }, @@ -968,26 +958,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -997,6 +986,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1090,15 +1083,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -1132,47 +1116,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -1181,20 +1128,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", @@ -1358,10 +1295,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1505,26 +1441,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1534,6 +1469,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1666,10 +1605,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1694,9 +1632,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] }, @@ -1828,26 +1767,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1857,6 +1795,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1950,15 +1892,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -1992,47 +1925,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -2041,20 +1937,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", diff --git a/src/rest/data/fpt-2026-03-10/gists.json b/src/rest/data/fpt-2026-03-10/gists.json index 2bd2d7c11c7a..4c15b84c53bc 100644 --- a/src/rest/data/fpt-2026-03-10/gists.json +++ b/src/rest/data/fpt-2026-03-10/gists.json @@ -1827,7 +1827,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -2571,7 +2571,7 @@ ] } ], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -6201,7 +6201,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -7294,7 +7294,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -7571,7 +7571,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -7853,7 +7853,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -8136,7 +8136,7 @@ "isRequired": true } ], - "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { diff --git a/src/rest/data/fpt-2026-03-10/secret-scanning.json b/src/rest/data/fpt-2026-03-10/secret-scanning.json index 35929386ce77..5fe5e5e2aaae 100644 --- a/src/rest/data/fpt-2026-03-10/secret-scanning.json +++ b/src/rest/data/fpt-2026-03-10/secret-scanning.json @@ -48,6 +48,24 @@ "type": "string" } }, + { + "name": "exclude_providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.

", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.

", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "resolution", "in": "query", @@ -571,6 +589,20 @@ "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -1910,6 +1942,24 @@ "type": "string" } }, + { + "name": "exclude_providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.

", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.

", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "resolution", "in": "query", @@ -2374,6 +2424,20 @@ "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -3581,6 +3645,20 @@ "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -4857,6 +4935,20 @@ "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." diff --git a/src/rest/data/ghec-2022-11-28/agent-tasks.json b/src/rest/data/ghec-2022-11-28/agent-tasks.json index 40550f3a7299..1dab325724e0 100644 --- a/src/rest/data/ghec-2022-11-28/agent-tasks.json +++ b/src/rest/data/ghec-2022-11-28/agent-tasks.json @@ -146,10 +146,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -293,26 +292,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -322,6 +320,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -433,20 +435,10 @@ } ], "bodyParameters": [ - { - "type": "integer", - "name": "agent_id", - "description": "

Agent ID (optional, defaults to coding agent)

" - }, { "type": "string", - "name": "problem_statement", - "description": "

Additional prompting for the agent

" - }, - { - "type": "string", - "name": "event_content", - "description": "

User's written prompt

", + "name": "prompt", + "description": "

The user's prompt for the agent

", "isRequired": true }, { @@ -454,15 +446,11 @@ "name": "model", "description": "

The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: claude-sonnet-4.6, claude-opus-4.6, gpt-5.2-codex, gpt-5.3-codex, gpt-5.4, claude-sonnet-4.5, claude-opus-4.5

" }, - { - "type": "string", - "name": "custom_agent", - "description": "

Custom agent identifier

" - }, { "type": "boolean", "name": "create_pull_request", - "description": "

Whether to create a PR

" + "description": "

Whether to create a PR.

", + "default": false }, { "type": "string", @@ -470,7 +458,7 @@ "description": "

Base ref for new branch/PR

" } ], - "descriptionHTML": "

Note

\n

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

\n
\n

Creates a new task for a repository

", + "descriptionHTML": "

Note

\n

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

\n
\n

Creates a new task for a repository.

", "codeExamples": [ { "request": { @@ -478,8 +466,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "event_content": "Fix the login button on the homepage", - "create_pull_request": true, + "prompt": "Fix the login button on the homepage", "base_ref": "main" }, "parameters": { @@ -639,26 +626,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -668,6 +654,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -806,10 +796,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -834,9 +823,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] }, @@ -968,26 +958,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -997,6 +986,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1090,15 +1083,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -1132,47 +1116,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -1181,20 +1128,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", @@ -1358,10 +1295,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1505,26 +1441,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1534,6 +1469,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1666,10 +1605,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1694,9 +1632,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] }, @@ -1828,26 +1767,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1857,6 +1795,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1950,15 +1892,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -1992,47 +1925,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -2041,20 +1937,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", diff --git a/src/rest/data/ghec-2022-11-28/gists.json b/src/rest/data/ghec-2022-11-28/gists.json index bc4027e59470..3c8ae0626b74 100644 --- a/src/rest/data/ghec-2022-11-28/gists.json +++ b/src/rest/data/ghec-2022-11-28/gists.json @@ -2616,7 +2616,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -3768,7 +3768,7 @@ ] } ], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -9157,7 +9157,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -10785,7 +10785,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11062,7 +11062,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11344,7 +11344,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11627,7 +11627,7 @@ "isRequired": true } ], - "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/secret-scanning.json b/src/rest/data/ghec-2022-11-28/secret-scanning.json index 5a8671bb0667..e11b8bebdba9 100644 --- a/src/rest/data/ghec-2022-11-28/secret-scanning.json +++ b/src/rest/data/ghec-2022-11-28/secret-scanning.json @@ -42,7 +42,25 @@ { "name": "exclude_secret_types", "in": "query", - "description": "

A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the secret_type parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", + "description": "

A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the secret_type parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "exclude_providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.

", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.

", "required": false, "schema": { "type": "string" @@ -562,6 +580,20 @@ "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -1888,6 +1920,24 @@ "type": "string" } }, + { + "name": "exclude_providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.

", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.

", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "resolution", "in": "query", @@ -2411,6 +2461,20 @@ "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -3750,6 +3814,24 @@ "type": "string" } }, + { + "name": "exclude_providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.

", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.

", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "resolution", "in": "query", @@ -4214,6 +4296,20 @@ "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -5421,6 +5517,20 @@ "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -6697,6 +6807,20 @@ "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -8566,6 +8690,419 @@ } ], "alert-dismissal-requests": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/dismissal-requests/secret-scanning", + "title": "List alert dismissal requests for secret scanning for an enterprise", + "category": "secret-scanning", + "subcategory": "alert-dismissal-requests", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name.

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

The name of the organization to filter on.

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

Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "requester", + "description": "

Filter bypass requests by the handle of the GitHub user who requested the bypass.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "

The time period to filter by.

\n

For example, day will filter for rule suites that occurred in the past 24 hours, and week will filter for rule suites that occurred in the past 7 days (168 hours).

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "hour", + "day", + "week", + "month" + ], + "default": "day" + } + }, + { + "name": "request_status", + "description": "

The status of the dismissal request to filter on. When specified, only requests with this status will be returned.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "cancelled", + "approved", + "expired", + "denied", + "open", + "all" + ], + "default": "all" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists requests to dismiss secret scanning alerts in an enterprise.

\n

The authenticated user must be an enterprise owner or an enterprise security manager to access this endpoint.\nPersonal access tokens (classic) need the security_events scope to use this endpoint.

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

A list of the alert dismissal requests.

", + "example": [ + { + "id": 21, + "number": 42, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning_closure", + "data": [ + { + "secret_type": "adafruit_io_key", + "alert_number": 17, + "reason": "false_positive" + } + ], + "resource_identifier": 17, + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/21", + "html_url": "https://github.com/octo-org/smile/security/secret-scanning/17" + }, + { + "id": 22, + "number": 43, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning_closure", + "data": [ + { + "secret_type": "adafruit_io_key", + "alert_number": 19 + } + ], + "resource_identifier": 19, + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 46, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "approved", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/22", + "html_url": "https://github.com/octo-org/smile/security/secret-scanning/19" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Secret scanning alert dismissal request", + "description": "A dismissal request made by a user asking to close a secret scanning alert in this repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the dismissal request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the dismissal request within its repository." + }, + "repository": { + "type": "object", + "description": "The repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the repository the dismissal request is for." + }, + "name": { + "type": "string", + "description": "The name of the repository the dismissal request is for." + }, + "full_name": { + "type": "string", + "description": "The full name of the repository the dismissal request is for." + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the organization." + }, + "name": { + "type": "string", + "description": "The name of the organization." + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the dismissal.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who requested the dismissal." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who requested the dismissal." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "type": [ + "array", + "null" + ], + "description": "Data describing the secret alert that is being requested to be dismissed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "alert_number": { + "type": "string", + "description": "The number of the secret scanning alert that was detected." + }, + "reason": { + "type": "string", + "description": "The reason the user provided for requesting the dismissal.", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The number of the secret scanning alert that was detected." + }, + "status": { + "type": "string", + "description": "The status of the dismissal request.", + "enum": [ + "pending", + "denied", + "approved", + "cancelled", + "expired" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the dismissal request." + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the dismissal request.", + "items": { + "title": "Bypass response", + "description": "A response made by a delegated bypasser to a bypass request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the response to the bypass request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the bypass request.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who reviewed the bypass request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the bypass request." + } + } + }, + "status": { + "type": "string", + "description": "The response status to the bypass request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the bypass request was created." + } + } + } + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "description": "The URL to view the dismissal request in a browser.", + "format": "uri" + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

A list of the alert dismissal requests.

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

Forbidden

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

Resource not found

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

Internal Error

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -12504,4 +13041,4 @@ } } ] -} +} \ No newline at end of file diff --git a/src/rest/data/ghec-2026-03-10/agent-tasks.json b/src/rest/data/ghec-2026-03-10/agent-tasks.json index 40550f3a7299..1dab325724e0 100644 --- a/src/rest/data/ghec-2026-03-10/agent-tasks.json +++ b/src/rest/data/ghec-2026-03-10/agent-tasks.json @@ -146,10 +146,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -293,26 +292,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -322,6 +320,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -433,20 +435,10 @@ } ], "bodyParameters": [ - { - "type": "integer", - "name": "agent_id", - "description": "

Agent ID (optional, defaults to coding agent)

" - }, { "type": "string", - "name": "problem_statement", - "description": "

Additional prompting for the agent

" - }, - { - "type": "string", - "name": "event_content", - "description": "

User's written prompt

", + "name": "prompt", + "description": "

The user's prompt for the agent

", "isRequired": true }, { @@ -454,15 +446,11 @@ "name": "model", "description": "

The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: claude-sonnet-4.6, claude-opus-4.6, gpt-5.2-codex, gpt-5.3-codex, gpt-5.4, claude-sonnet-4.5, claude-opus-4.5

" }, - { - "type": "string", - "name": "custom_agent", - "description": "

Custom agent identifier

" - }, { "type": "boolean", "name": "create_pull_request", - "description": "

Whether to create a PR

" + "description": "

Whether to create a PR.

", + "default": false }, { "type": "string", @@ -470,7 +458,7 @@ "description": "

Base ref for new branch/PR

" } ], - "descriptionHTML": "

Note

\n

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

\n
\n

Creates a new task for a repository

", + "descriptionHTML": "

Note

\n

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

\n
\n

Creates a new task for a repository.

", "codeExamples": [ { "request": { @@ -478,8 +466,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "event_content": "Fix the login button on the homepage", - "create_pull_request": true, + "prompt": "Fix the login button on the homepage", "base_ref": "main" }, "parameters": { @@ -639,26 +626,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -668,6 +654,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -806,10 +796,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -834,9 +823,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] }, @@ -968,26 +958,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -997,6 +986,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1090,15 +1083,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -1132,47 +1116,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -1181,20 +1128,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", @@ -1358,10 +1295,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1505,26 +1441,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1534,6 +1469,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1666,10 +1605,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1694,9 +1632,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] }, @@ -1828,26 +1767,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1857,6 +1795,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1950,15 +1892,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -1992,47 +1925,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -2041,20 +1937,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", diff --git a/src/rest/data/ghec-2026-03-10/gists.json b/src/rest/data/ghec-2026-03-10/gists.json index 50dad4adda46..a977f44907cd 100644 --- a/src/rest/data/ghec-2026-03-10/gists.json +++ b/src/rest/data/ghec-2026-03-10/gists.json @@ -1827,7 +1827,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -2571,7 +2571,7 @@ ] } ], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -6201,7 +6201,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -7294,7 +7294,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -7571,7 +7571,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -7853,7 +7853,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -8136,7 +8136,7 @@ "isRequired": true } ], - "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/secret-scanning.json b/src/rest/data/ghec-2026-03-10/secret-scanning.json index 5a8671bb0667..e11b8bebdba9 100644 --- a/src/rest/data/ghec-2026-03-10/secret-scanning.json +++ b/src/rest/data/ghec-2026-03-10/secret-scanning.json @@ -42,7 +42,25 @@ { "name": "exclude_secret_types", "in": "query", - "description": "

A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the secret_type parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", + "description": "

A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the secret_type parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "exclude_providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.

", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.

", "required": false, "schema": { "type": "string" @@ -562,6 +580,20 @@ "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -1888,6 +1920,24 @@ "type": "string" } }, + { + "name": "exclude_providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.

", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.

", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "resolution", "in": "query", @@ -2411,6 +2461,20 @@ "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -3750,6 +3814,24 @@ "type": "string" } }, + { + "name": "exclude_providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.

", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "providers", + "in": "query", + "description": "

A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.

", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "resolution", "in": "query", @@ -4214,6 +4296,20 @@ "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -5421,6 +5517,20 @@ "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -6697,6 +6807,20 @@ "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, + "provider": { + "type": [ + "string", + "null" + ], + "description": "The provider of the secret that was detected." + }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -8566,6 +8690,419 @@ } ], "alert-dismissal-requests": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/dismissal-requests/secret-scanning", + "title": "List alert dismissal requests for secret scanning for an enterprise", + "category": "secret-scanning", + "subcategory": "alert-dismissal-requests", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name.

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

The name of the organization to filter on.

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

Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "requester", + "description": "

Filter bypass requests by the handle of the GitHub user who requested the bypass.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "

The time period to filter by.

\n

For example, day will filter for rule suites that occurred in the past 24 hours, and week will filter for rule suites that occurred in the past 7 days (168 hours).

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "hour", + "day", + "week", + "month" + ], + "default": "day" + } + }, + { + "name": "request_status", + "description": "

The status of the dismissal request to filter on. When specified, only requests with this status will be returned.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "cancelled", + "approved", + "expired", + "denied", + "open", + "all" + ], + "default": "all" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "descriptionHTML": "

Lists requests to dismiss secret scanning alerts in an enterprise.

\n

The authenticated user must be an enterprise owner or an enterprise security manager to access this endpoint.\nPersonal access tokens (classic) need the security_events scope to use this endpoint.

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

A list of the alert dismissal requests.

", + "example": [ + { + "id": 21, + "number": 42, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning_closure", + "data": [ + { + "secret_type": "adafruit_io_key", + "alert_number": 17, + "reason": "false_positive" + } + ], + "resource_identifier": 17, + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/21", + "html_url": "https://github.com/octo-org/smile/security/secret-scanning/17" + }, + { + "id": 22, + "number": 43, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning_closure", + "data": [ + { + "secret_type": "adafruit_io_key", + "alert_number": 19 + } + ], + "resource_identifier": 19, + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 46, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "approved", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/22", + "html_url": "https://github.com/octo-org/smile/security/secret-scanning/19" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Secret scanning alert dismissal request", + "description": "A dismissal request made by a user asking to close a secret scanning alert in this repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the dismissal request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the dismissal request within its repository." + }, + "repository": { + "type": "object", + "description": "The repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the repository the dismissal request is for." + }, + "name": { + "type": "string", + "description": "The name of the repository the dismissal request is for." + }, + "full_name": { + "type": "string", + "description": "The full name of the repository the dismissal request is for." + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the organization." + }, + "name": { + "type": "string", + "description": "The name of the organization." + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the dismissal.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who requested the dismissal." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who requested the dismissal." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "type": [ + "array", + "null" + ], + "description": "Data describing the secret alert that is being requested to be dismissed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "alert_number": { + "type": "string", + "description": "The number of the secret scanning alert that was detected." + }, + "reason": { + "type": "string", + "description": "The reason the user provided for requesting the dismissal.", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The number of the secret scanning alert that was detected." + }, + "status": { + "type": "string", + "description": "The status of the dismissal request.", + "enum": [ + "pending", + "denied", + "approved", + "cancelled", + "expired" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the dismissal request." + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the dismissal request.", + "items": { + "title": "Bypass response", + "description": "A response made by a delegated bypasser to a bypass request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the response to the bypass request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the bypass request.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who reviewed the bypass request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the bypass request." + } + } + }, + "status": { + "type": "string", + "description": "The response status to the bypass request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the bypass request was created." + } + } + } + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "description": "The URL to view the dismissal request in a browser.", + "format": "uri" + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

A list of the alert dismissal requests.

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

Forbidden

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

Resource not found

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

Internal Error

" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -12504,4 +13041,4 @@ } } ] -} +} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/gists.json b/src/rest/data/ghes-3.14-2022-11-28/gists.json index 34c581ede6ea..ec0b6d5676b4 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/gists.json +++ b/src/rest/data/ghes-3.14-2022-11-28/gists.json @@ -2599,7 +2599,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -3743,7 +3743,7 @@ ] } ], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -9103,7 +9103,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -10720,7 +10720,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -10997,7 +10997,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11279,7 +11279,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11562,7 +11562,7 @@ "isRequired": true } ], - "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghes-3.15-2022-11-28/gists.json b/src/rest/data/ghes-3.15-2022-11-28/gists.json index 174747bbba0f..8d1070be11a2 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/gists.json +++ b/src/rest/data/ghes-3.15-2022-11-28/gists.json @@ -2599,7 +2599,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -3743,7 +3743,7 @@ ] } ], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -9103,7 +9103,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -10720,7 +10720,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -10997,7 +10997,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11279,7 +11279,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11562,7 +11562,7 @@ "isRequired": true } ], - "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghes-3.16-2022-11-28/gists.json b/src/rest/data/ghes-3.16-2022-11-28/gists.json index 1ab79358fd9d..8ef597515f03 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/gists.json +++ b/src/rest/data/ghes-3.16-2022-11-28/gists.json @@ -2599,7 +2599,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -3743,7 +3743,7 @@ ] } ], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -9103,7 +9103,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -10720,7 +10720,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -10997,7 +10997,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11279,7 +11279,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11562,7 +11562,7 @@ "isRequired": true } ], - "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghes-3.17-2022-11-28/gists.json b/src/rest/data/ghes-3.17-2022-11-28/gists.json index fc2cb6f39ee8..51d7d6812492 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/gists.json +++ b/src/rest/data/ghes-3.17-2022-11-28/gists.json @@ -2616,7 +2616,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -3768,7 +3768,7 @@ ] } ], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -9157,7 +9157,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -10785,7 +10785,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11062,7 +11062,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11344,7 +11344,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11627,7 +11627,7 @@ "isRequired": true } ], - "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghes-3.18-2022-11-28/gists.json b/src/rest/data/ghes-3.18-2022-11-28/gists.json index 60f7ef71bab4..4abb5a5a2caf 100644 --- a/src/rest/data/ghes-3.18-2022-11-28/gists.json +++ b/src/rest/data/ghes-3.18-2022-11-28/gists.json @@ -2616,7 +2616,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -3768,7 +3768,7 @@ ] } ], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -9157,7 +9157,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -10785,7 +10785,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11062,7 +11062,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11344,7 +11344,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11627,7 +11627,7 @@ "isRequired": true } ], - "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghes-3.19-2022-11-28/gists.json b/src/rest/data/ghes-3.19-2022-11-28/gists.json index 29edaefbf084..39b083b583ac 100644 --- a/src/rest/data/ghes-3.19-2022-11-28/gists.json +++ b/src/rest/data/ghes-3.19-2022-11-28/gists.json @@ -2616,7 +2616,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -3768,7 +3768,7 @@ ] } ], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -9157,7 +9157,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -10785,7 +10785,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11062,7 +11062,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11344,7 +11344,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11627,7 +11627,7 @@ "isRequired": true } ], - "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghes-3.20-2022-11-28/gists.json b/src/rest/data/ghes-3.20-2022-11-28/gists.json index d2921eea9718..b2cd2583d305 100644 --- a/src/rest/data/ghes-3.20-2022-11-28/gists.json +++ b/src/rest/data/ghes-3.20-2022-11-28/gists.json @@ -2616,7 +2616,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -3768,7 +3768,7 @@ ] } ], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -9157,7 +9157,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -10785,7 +10785,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11062,7 +11062,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11344,7 +11344,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { @@ -11627,7 +11627,7 @@ "isRequired": true } ], - "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", + "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "codeExamples": [ { "request": { diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 14db94b004df..da35b74eaa59 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -55,5 +55,5 @@ ] } }, - "sha": "2d6cbdb1321b97517f0af20e94eff59e89a36c25" + "sha": "36e6d2087a74bda6b56e450420eee3427798bc75" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 98c358e473a6..62660e4fc3b0 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -260244,6 +260244,16 @@ "name": "secret_type_display_name", "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

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

The provider of the secret that was detected.

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

The slug identifier for the provider of the secret that was detected.

" + }, { "type": "string", "name": "validity", @@ -261235,6 +261245,16 @@ "name": "secret_type_display_name", "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

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

The provider of the secret that was detected.

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

The slug identifier for the provider of the secret that was detected.

" + }, { "type": "string", "name": "validity", @@ -262091,6 +262111,16 @@ "name": "secret_type_display_name", "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

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

The provider of the secret that was detected.

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

The slug identifier for the provider of the secret that was detected.

" + }, { "type": "string", "name": "validity", @@ -262947,6 +262977,16 @@ "name": "secret_type_display_name", "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

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

The provider of the secret that was detected.

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

The slug identifier for the provider of the secret that was detected.

" + }, { "type": "string", "name": "validity", @@ -263803,6 +263843,16 @@ "name": "secret_type_display_name", "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

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

The provider of the secret that was detected.

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

The slug identifier for the provider of the secret that was detected.

" + }, { "type": "string", "name": "validity", @@ -264659,6 +264709,16 @@ "name": "secret_type_display_name", "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

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

The provider of the secret that was detected.

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

The slug identifier for the provider of the secret that was detected.

" + }, { "type": "string", "name": "validity", @@ -265650,6 +265710,16 @@ "name": "secret_type_display_name", "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

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

The provider of the secret that was detected.

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

The slug identifier for the provider of the secret that was detected.

" + }, { "type": "string", "name": "validity", @@ -266507,6 +266577,16 @@ "name": "secret_type_display_name", "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

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

The provider of the secret that was detected.

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

The slug identifier for the provider of the secret that was detected.

" + }, { "type": "string", "name": "validity", diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 23bc0fe6ca12..8479c5bd7d97 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -269144,6 +269144,16 @@ "name": "secret_type_display_name", "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

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

The provider of the secret that was detected.

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

The slug identifier for the provider of the secret that was detected.

" + }, { "type": "string", "name": "validity", @@ -270135,6 +270145,16 @@ "name": "secret_type_display_name", "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

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

The provider of the secret that was detected.

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

The slug identifier for the provider of the secret that was detected.

" + }, { "type": "string", "name": "validity", @@ -270991,6 +271011,16 @@ "name": "secret_type_display_name", "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

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

The provider of the secret that was detected.

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

The slug identifier for the provider of the secret that was detected.

" + }, { "type": "string", "name": "validity", @@ -271847,6 +271877,16 @@ "name": "secret_type_display_name", "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

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

The provider of the secret that was detected.

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

The slug identifier for the provider of the secret that was detected.

" + }, { "type": "string", "name": "validity", @@ -272703,6 +272743,16 @@ "name": "secret_type_display_name", "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

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

The provider of the secret that was detected.

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

The slug identifier for the provider of the secret that was detected.

" + }, { "type": "string", "name": "validity", @@ -273559,6 +273609,16 @@ "name": "secret_type_display_name", "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

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

The provider of the secret that was detected.

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

The slug identifier for the provider of the secret that was detected.

" + }, { "type": "string", "name": "validity", @@ -274550,6 +274610,16 @@ "name": "secret_type_display_name", "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

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

The provider of the secret that was detected.

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

The slug identifier for the provider of the secret that was detected.

" + }, { "type": "string", "name": "validity", @@ -275407,6 +275477,16 @@ "name": "secret_type_display_name", "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

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

The provider of the secret that was detected.

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

The slug identifier for the provider of the secret that was detected.

" + }, { "type": "string", "name": "validity", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 6236e7eb6cda..ad671ef70bdd 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "2d6cbdb1321b97517f0af20e94eff59e89a36c25" + "sha": "36e6d2087a74bda6b56e450420eee3427798bc75" } \ No newline at end of file