From 7db93a7c7b5751aca9a08c1cef87f946e9decd65 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Wed, 1 Apr 2026 18:13:20 -0700 Subject: [PATCH 01/11] Add Copilot SDK Integrations map category and Microsoft Agent Framework article (#60448) Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: sunbrye <56200261+sunbrye@users.noreply.github.com> Co-authored-by: sunbrye --- content/copilot/how-tos/copilot-sdk/index.md | 1 + .../how-tos/copilot-sdk/integrations/index.md | 10 + .../integrations/microsoft-agent-framework.md | 322 ++++++++++++++++++ 3 files changed, 333 insertions(+) create mode 100644 content/copilot/how-tos/copilot-sdk/integrations/index.md create mode 100644 content/copilot/how-tos/copilot-sdk/integrations/microsoft-agent-framework.md diff --git a/content/copilot/how-tos/copilot-sdk/index.md b/content/copilot/how-tos/copilot-sdk/index.md index b0149466bb81..467286e85a9e 100644 --- a/content/copilot/how-tos/copilot-sdk/index.md +++ b/content/copilot/how-tos/copilot-sdk/index.md @@ -11,6 +11,7 @@ children: - /use-copilot-sdk - /use-hooks - /observability + - /integrations - /troubleshooting contentType: how-tos --- diff --git a/content/copilot/how-tos/copilot-sdk/integrations/index.md b/content/copilot/how-tos/copilot-sdk/integrations/index.md new file mode 100644 index 000000000000..e4eaa34c69b5 --- /dev/null +++ b/content/copilot/how-tos/copilot-sdk/integrations/index.md @@ -0,0 +1,10 @@ +--- +title: Copilot SDK integrations +shortTitle: Integrations +intro: Integrate {% data variables.copilot.copilot_sdk_short %} with third-party agent frameworks and orchestration platforms. +versions: + feature: copilot +contentType: how-tos +children: + - /microsoft-agent-framework +--- diff --git a/content/copilot/how-tos/copilot-sdk/integrations/microsoft-agent-framework.md b/content/copilot/how-tos/copilot-sdk/integrations/microsoft-agent-framework.md new file mode 100644 index 000000000000..3c210d76fafa --- /dev/null +++ b/content/copilot/how-tos/copilot-sdk/integrations/microsoft-agent-framework.md @@ -0,0 +1,322 @@ +--- +title: Microsoft Agent Framework integration +shortTitle: Microsoft Agent Framework +intro: Use {% data variables.copilot.copilot_sdk_short %} as an agent provider inside the Microsoft Agent Framework to build and orchestrate multi-agent workflows alongside other AI providers. +versions: + feature: copilot +product: '{% data reusables.gated-features.copilot-sdk %}' +contentType: how-tos +--- + +> [!NOTE] +> {% data variables.copilot.copilot_sdk_short %} is currently in {% data variables.release-phases.technical_preview %}. Functionality and availability are subject to change. + +Use {% data variables.copilot.copilot_sdk_short %} as an agent provider inside the [Microsoft Agent Framework](https://devblogs.microsoft.com/semantic-kernel/build-ai-agents-with-github-copilot-sdk-and-microsoft-agent-framework/) (MAF) to compose multi-agent workflows alongside Azure OpenAI, Anthropic, and other providers. + +## Overview + +The Microsoft Agent Framework is the unified successor to Semantic Kernel and AutoGen. It provides a standard interface for building, orchestrating, and deploying AI agents. Dedicated integration packages let you wrap a {% data variables.copilot.copilot_sdk_short %} client as a first-class MAF agent—interchangeable with any other agent provider in the framework. + +| Concept | Description | +|---------|-------------| +| Microsoft Agent Framework | Open-source framework for single- and multi-agent orchestration in .NET and Python | +| Agent provider | A backend that powers an agent (Copilot, Azure OpenAI, Anthropic, etc.) | +| Orchestrator | A MAF component that coordinates agents in sequential, concurrent, or handoff workflows | +| A2A protocol | Agent-to-Agent communication standard supported by the framework | + +> [!NOTE] +> MAF integration packages are available for .NET and Python. For TypeScript and Go, use the {% data variables.copilot.copilot_sdk_short %} directly—the standard SDK APIs provide tool calling, streaming, and custom agents. + +## Prerequisites + +Before you begin, make sure you have: + +* A working {% data variables.copilot.copilot_sdk_short %} setup in your language of choice. See [AUTOTITLE](/copilot/how-tos/copilot-sdk/sdk-getting-started). +* A {% data variables.product.prodname_copilot %} subscription (Individual, Business, or Enterprise). +* {% data variables.copilot.copilot_cli_short %} installed or available via the SDK's bundled CLI. + +## Installation + +Install the {% data variables.copilot.copilot_sdk_short %} alongside the MAF integration package: + +```shell +dotnet add package GitHub.Copilot.SDK +dotnet add package Microsoft.Agents.AI.GitHub.Copilot --prerelease +``` + +For examples in Python, see the [`microsoft-agent-framework`](https://github.com/github/copilot-sdk/blob/main/docs/integrations/microsoft-agent-framework.md) article in the `github/copilot-sdk` repository. + +## Basic usage + +Wrap the {% data variables.copilot.copilot_sdk_short %} client as a MAF agent with a single method call. The resulting agent conforms to the framework's standard interface and can be used anywhere a MAF agent is expected. + +```csharp +using GitHub.Copilot.SDK; +using Microsoft.Agents.AI; + +await using var copilotClient = new CopilotClient(); +await copilotClient.StartAsync(); + +// Wrap as a MAF agent +AIAgent agent = copilotClient.AsAIAgent(); + +// Use the standard MAF interface +string response = await agent.RunAsync("Explain how dependency injection works in ASP.NET Core"); +Console.WriteLine(response); +``` + +For examples in Python, see the [`microsoft-agent-framework`](https://github.com/github/copilot-sdk/blob/main/docs/integrations/microsoft-agent-framework.md) article in the `github/copilot-sdk` repository. + +## Adding custom tools + +Extend your {% data variables.product.prodname_copilot_short %} agent with custom function tools. Tools defined through the standard {% data variables.copilot.copilot_sdk_short %} are automatically available when the agent runs inside MAF. + +```csharp +using GitHub.Copilot.SDK; +using Microsoft.Extensions.AI; +using Microsoft.Agents.AI; + +// Define a custom tool +AIFunction weatherTool = AIFunctionFactory.Create( + (string location) => $"The weather in {location} is sunny with a high of 25°C.", + "GetWeather", + "Get the current weather for a given location." +); + +await using var copilotClient = new CopilotClient(); +await copilotClient.StartAsync(); + +// Create agent with tools +AIAgent agent = copilotClient.AsAIAgent(new AIAgentOptions +{ + Tools = new[] { weatherTool }, +}); + +string response = await agent.RunAsync("What's the weather like in Seattle?"); +Console.WriteLine(response); +``` + +You can also use the {% data variables.copilot.copilot_sdk_short %}'s native tool definition alongside MAF tools: + +```typescript +import { CopilotClient, DefineTool } from "@github/copilot-sdk"; + +const getWeather = DefineTool({ + name: "GetWeather", + description: "Get the current weather for a given location.", + parameters: { location: { type: "string", description: "City name" } }, + execute: async ({ location }) => `The weather in ${location} is sunny, 25°C.`, +}); + +const client = new CopilotClient(); +const session = await client.createSession({ + model: "gpt-4.1", + tools: [getWeather], + onPermissionRequest: async () => ({ kind: "approved" }), +}); + +await session.sendAndWait({ prompt: "What's the weather like in Seattle?" }); +``` + +> [!WARNING] +> Setting `onPermissionRequest` to always return `{ kind: "approved" }` can allow prompt injections without approval. For production use, implement policy-based approval that evaluates the requested tool and its parameters before granting permission. + +For examples in Python, see the [`microsoft-agent-framework`](https://github.com/github/copilot-sdk/blob/main/docs/integrations/microsoft-agent-framework.md) article in the `github/copilot-sdk` repository. + +## Multi-agent workflows + +The primary benefit of MAF integration is composing {% data variables.product.prodname_copilot_short %} alongside other agent providers in orchestrated workflows. Use the framework's built-in orchestrators to create pipelines where different agents handle different steps. + +### Sequential workflow + +Run agents one after another, passing output from one to the next: + +```csharp +using GitHub.Copilot.SDK; +using Microsoft.Agents.AI; +using Microsoft.Agents.AI.Orchestration; + +await using var copilotClient = new CopilotClient(); +await copilotClient.StartAsync(); + +// Copilot agent for code review +AIAgent reviewer = copilotClient.AsAIAgent(new AIAgentOptions +{ + Instructions = "You review code for bugs, security issues, and best practices. Be thorough.", +}); + +// Azure OpenAI agent for generating documentation +AIAgent documentor = AIAgent.FromOpenAI(new OpenAIAgentOptions +{ + Model = "gpt-4.1", + Instructions = "You write clear, concise documentation for code changes.", +}); + +// Compose in a sequential pipeline +var pipeline = new SequentialOrchestrator(new[] { reviewer, documentor }); + +string result = await pipeline.RunAsync( + "Review and document this pull request: added retry logic to the HTTP client" +); +Console.WriteLine(result); +``` + +For examples in Python, see the [`microsoft-agent-framework`](https://github.com/github/copilot-sdk/blob/main/docs/integrations/microsoft-agent-framework.md) article in the `github/copilot-sdk` repository. + +### Concurrent workflow + +Run multiple agents in parallel and aggregate their results: + +```csharp +using GitHub.Copilot.SDK; +using Microsoft.Agents.AI; +using Microsoft.Agents.AI.Orchestration; + +await using var copilotClient = new CopilotClient(); +await copilotClient.StartAsync(); + +AIAgent securityReviewer = copilotClient.AsAIAgent(new AIAgentOptions +{ + Instructions = "Focus exclusively on security vulnerabilities and risks.", +}); + +AIAgent performanceReviewer = copilotClient.AsAIAgent(new AIAgentOptions +{ + Instructions = "Focus exclusively on performance bottlenecks and optimization opportunities.", +}); + +// Run both reviews concurrently +var concurrent = new ConcurrentOrchestrator(new[] { securityReviewer, performanceReviewer }); + +string combinedResult = await concurrent.RunAsync( + "Analyze this database query module for issues" +); +Console.WriteLine(combinedResult); +``` + +## Streaming responses + +When building interactive applications, stream agent responses to show real-time output. The MAF integration preserves the {% data variables.copilot.copilot_sdk_short %}'s streaming capabilities. + +```csharp +using GitHub.Copilot.SDK; +using Microsoft.Agents.AI; + +await using var copilotClient = new CopilotClient(); +await copilotClient.StartAsync(); + +AIAgent agent = copilotClient.AsAIAgent(new AIAgentOptions +{ + Streaming = true, +}); + +await foreach (var chunk in agent.RunStreamingAsync("Write a quicksort implementation in C#")) +{ + Console.Write(chunk); +} +Console.WriteLine(); +``` + +You can also stream directly through the {% data variables.copilot.copilot_sdk_short %} without MAF: + +```typescript +import { CopilotClient } from "@github/copilot-sdk"; + +const client = new CopilotClient(); +const session = await client.createSession({ + model: "gpt-4.1", + streaming: true, + onPermissionRequest: async () => ({ kind: "approved" }), +}); + +session.on("assistant.message_delta", (event) => { + process.stdout.write(event.data.delta ?? ""); +}); + +await session.sendAndWait({ prompt: "Write a quicksort implementation in TypeScript" }); +``` + +For examples in Python, see the [`microsoft-agent-framework`](https://github.com/github/copilot-sdk/blob/main/docs/integrations/microsoft-agent-framework.md) article in the `github/copilot-sdk` repository. + +## Configuration reference + +### MAF agent options + +| Property | Type | Description | +|----------------|------------------|-------------| +| `Instructions` | string | System prompt for the agent | +| `Tools` | AIFunction[] or list | Custom function tools available to the agent | +| `Streaming` | bool | Enable streaming responses | +| `Model` | string | Override the default model | + +### Copilot SDK options (passed through) + +All standard `SessionConfig` options are available when creating the underlying {% data variables.product.prodname_copilot_short %} client. The MAF wrapper delegates to the SDK under the hood. + +| SDK feature | MAF support | +|-----------------------------------------------------|-------------| +| Custom tools (`DefineTool` and `AIFunctionFactory`) | Merged with MAF tools | +| MCP servers | Configured on the SDK client | +| Custom agents and sub-agents | Available within the Copilot agent | +| Infinite sessions | Configured on the SDK client | +| Model selection | Overridable per agent or per call | +| Streaming | Full delta event support | + +## Best practices + +### Choose the right level of integration + +Use the MAF wrapper when you need to compose {% data variables.product.prodname_copilot_short %} with other providers in orchestrated workflows. If your application only uses {% data variables.product.prodname_copilot_short %}, the standalone SDK is simpler and gives you full control: + +```typescript +// Standalone SDK — full control, simpler setup +import { CopilotClient } from "@github/copilot-sdk"; + +const client = new CopilotClient(); +const session = await client.createSession({ + model: "gpt-4.1", + onPermissionRequest: async () => ({ kind: "approved" }), +}); +const response = await session.sendAndWait({ prompt: "Explain this code" }); +``` + +### Keep agents focused + +When building multi-agent workflows, give each agent a specific role with clear instructions. Avoid overlapping responsibilities: + +```typescript +// Too vague — overlapping roles +const agents = [ + { instructions: "Help with code" }, + { instructions: "Assist with programming" }, +]; + +// Focused — clear separation of concerns +const agents = [ + { instructions: "Review code for security vulnerabilities. Flag SQL injection, XSS, and auth issues." }, + { instructions: "Optimize code performance. Focus on algorithmic complexity and memory usage." }, +]; +``` + +### Handle errors at the orchestration level + +Wrap agent calls in error handling, especially in multi-agent workflows where one agent's failure shouldn't block the entire pipeline: + +```csharp +try +{ + string result = await pipeline.RunAsync("Analyze this module"); + Console.WriteLine(result); +} +catch (AgentException ex) +{ + Console.Error.WriteLine($"Agent {ex.AgentName} failed: {ex.Message}"); + // Fall back to single-agent mode or retry +} +``` + +## Further reading + +* [AUTOTITLE](/copilot/how-tos/copilot-sdk/sdk-getting-started) +* [Microsoft Agent Framework documentation](https://learn.microsoft.com/en-us/agent-framework/agents/providers/github-copilot) +* [Blog: Build AI Agents with GitHub Copilot SDK and Microsoft Agent Framework](https://devblogs.microsoft.com/semantic-kernel/build-ai-agents-with-github-copilot-sdk-and-microsoft-agent-framework/) From fb5765555c7bff2076040c1c5d052c7fe8121353 Mon Sep 17 00:00:00 2001 From: Stacy Carter Date: Wed, 1 Apr 2026 21:44:19 -0400 Subject: [PATCH 02/11] Clarify how pending and failed invitations affect license consumption (#60578) Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com> --- content/billing/reference/github-license-users.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/content/billing/reference/github-license-users.md b/content/billing/reference/github-license-users.md index 21ac91792dda..6d9ce8033ef5 100644 --- a/content/billing/reference/github-license-users.md +++ b/content/billing/reference/github-license-users.md @@ -37,6 +37,7 @@ category: * Billing managers * Anyone with a pending invitation to become a billing manager * Anyone with a pending invitation to become an outside collaborator on a public repository owned by your organization +* Anyone with a failed invitation to become an organization member or an outside collaborator on a repository owned by your organization ## Organizations on {% data variables.product.prodname_ghe_cloud %} @@ -53,19 +54,21 @@ category: If your enterprise does not use {% data variables.product.prodname_emus %}, you will also be billed for each of the following accounts: * Anyone with a pending invitation to become an organization owner or member + * If the invited user already consumes an enterprise license, a pending organization invitation won't use an additional license—as long as the invitation is sent to their {% data variables.product.github %} username or a verified email address on their account. * Anyone with a pending invitation to become an outside collaborator on private or internal repositories owned by your organization, excluding forks * {% data reusables.organizations.org-invite-scim %} - * Inviting an outside collaborator to a repository using their email address temporarily uses an available seat, even if they already have access to other repositories. After they accept the invite, the seat will be freed up again. Inviting them using their username does not temporarily use a seat. + * If the invited user already consumes an enterprise license because they're a collaborator on an internal or private repository in the enterprise, a pending collaborator invitation using their email address for another repository in the enterprise consumes an available seat. After they accept the invite, the seat will be freed up again. Inviting them using their username does not temporarily use a seat. ### People who don't consume licenses -* {% data variables.enterprise.prodname_managed_users_caps %} that are suspended +* Suspended {% data variables.enterprise.prodname_managed_users_caps %} * Enterprise owners who are not a member or owner of at least one organization in the enterprise * The user who set up the enterprise * Enterprise billing managers * Billing managers for individual organizations * Anyone with a pending invitation to become a billing manager * Anyone who is an outside collaborator on a public repository owned by your organization, or who has a pending invitation to become one +* Anyone with a failed invitation to become an organization member or an outside collaborator on a repository owned by your organization * Guest collaborators who are not organization members or repository collaborators (see [AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#guest-collaborators)) * Users of {% data variables.visual_studio.prodname_vss_ghe %} whose accounts on {% data variables.product.prodname_dotcom %} are not linked, and who do not meet any of the other criteria for per-user pricing * Unaffiliated users: people who have been added to the enterprise, but are not members of any organizations in the enterprise From f137b50b007ec332a6cf5b5caafc5857072d6eac Mon Sep 17 00:00:00 2001 From: Ryosuke Nakayama Date: Thu, 2 Apr 2026 15:22:56 +0900 Subject: [PATCH 03/11] Update proxy server documentation with no_proxy warning (#60604) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- content/actions/how-tos/manage-runners/use-proxy-servers.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/content/actions/how-tos/manage-runners/use-proxy-servers.md b/content/actions/how-tos/manage-runners/use-proxy-servers.md index ee960f660c69..1d7ebd210a62 100644 --- a/content/actions/how-tos/manage-runners/use-proxy-servers.md +++ b/content/actions/how-tos/manage-runners/use-proxy-servers.md @@ -32,6 +32,10 @@ On Windows machines, the proxy environment variable names are case-insensitive. {% data reusables.actions.self-hosted-runner-ports-protocols %} +> [!WARNING] +> Self-hosted runners do not support using IP addresses in the `no_proxy` environment variable. If your {% data variables.product.prodname_ghe_server %} instance uses an IP address and you configure `no_proxy` to bypass the proxy for that address, the runner will still fail to connect. +> If your {% data variables.product.prodname_ghe_server %} instance is accessed using an IP address and the connection must bypass the proxy, the runner will fail to connect, even if that IP address is listed in `no_proxy`. + ### Example configurations {% data reusables.actions.environment-variables-as-case-sensitive %} From dce2a2b746493270ef3268c463bd4ac7173bd1af Mon Sep 17 00:00:00 2001 From: mc <42146119+mchammer01@users.noreply.github.com> Date: Thu, 2 Apr 2026 08:26:46 +0200 Subject: [PATCH 04/11] [Secrets + SRA initiative] New conceptual article about best practices for selecting pilot repos (#60348) Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Laura Coursen --- ...ctices-for-selecting-pilot-repositories.md | 95 +++++++++++++++++++ .../concepts/security-at-scale/index.md | 1 + .../protect-your-secrets.md | 5 +- ...rpreting-secret-risk-assessment-results.md | 2 +- 4 files changed, 101 insertions(+), 2 deletions(-) create mode 100644 content/code-security/concepts/security-at-scale/best-practices-for-selecting-pilot-repositories.md diff --git a/content/code-security/concepts/security-at-scale/best-practices-for-selecting-pilot-repositories.md b/content/code-security/concepts/security-at-scale/best-practices-for-selecting-pilot-repositories.md new file mode 100644 index 000000000000..18ade67c6b74 --- /dev/null +++ b/content/code-security/concepts/security-at-scale/best-practices-for-selecting-pilot-repositories.md @@ -0,0 +1,95 @@ +--- +title: Best practices for selecting pilot repositories +shortTitle: Select pilot repositories +intro: 'The right pilot repositories demonstrate value quickly and prepare your organization for broader enablement of {% data variables.product.prodname_GH_secret_protection %}.' +versions: + fpt: '*' + ghec: '*' + ghes: '*' +contentType: concepts +--- + +Before enabling {% data variables.product.prodname_GH_secret_protection %} organization-wide, run a pilot to validate the solution with a small set of repositories. A pilot helps you refine your rollout strategy, identify workflow adjustments, and demonstrate security value to stakeholders. This article will help you choose the best repositories for your pilot. + +A successful pilot requires strategic repository selection. The repositories you choose determine how quickly you can demonstrate value, gather actionable feedback, and prepare for organization-wide adoption. + +## Selection criteria + +A successful pilot requires strategic repository selection. The repositories you choose determine how quickly you can demonstrate value, gather actionable feedback, and prepare for organization-wide adoption. + +When choosing repositories, consider the following criteria. + +### Active development and team engagement + +Your pilot needs repositories that generate timely feedback on how {% data variables.product.prodname_secret_protection %} fits into daily development work. + +* Select repositories with **regular commits and pull requests**. Active repositories generate feedback quickly and show how {% data variables.product.prodname_secret_protection %} fits into real development workflows. +* Choose **teams** that will engage with the pilot. Responsive maintainers will identify workflow adjustments faster and help refine your rollout strategy. +* **Use repository properties** to systematically identify repositories by team, criticality, or other custom attributes. See [AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization). + +### Known secret exposure + +{% ifversion secret-risk-assessment %} + +Choose repositories flagged in your secret risk assessment. These repositories are ideal pilot candidates because they demonstrate immediate value by showing secrets that need remediation. + +{% else %} + +Choose repositories you suspect contain secrets based on past incidents or security reviews. These repositories are ideal pilot candidates because they allow you to validate the tool's effectiveness quickly. + +{% endif %} + +Prioritize repositories with production credentials, infrastructure configurations, or integrations with critical services. These high-value targets demonstrate the security value of {% data variables.product.prodname_secret_protection %}. + +### Technical diversity + +Your pilot should validate that {% data variables.product.prodname_secret_protection %} works with your programming languages and tools. + +* Include repositories using different programming languages and frameworks. This validates {% data variables.product.prodname_secret_protection %} coverage across your codebase. +* Select repositories with CI/CD pipelines to identify potential deployment impacts early. Understanding these interactions prevents surprises during broader rollout. + +### Organizational representation + +A successful pilot requires buy-in from different parts of your organization. + +* Choose repositories from different teams or business units. Diverse feedback reveals patterns that wouldn't emerge from a single team's experience. +* Include at least one repository that leadership cares about. Executive visibility maintains pilot momentum and facilitates future budget discussions. + +### Repositories to avoid initially + +Not all repositories make good pilot candidates. + +* **Low-activity or archived repositories**: You won't get timely workflow feedback. +* **Experimental or personal repositories**: These repositories don't reflect production patterns. +* **Repositories with complex custom tooling**: Unusual workflows may complicate feedback. +* **Mission-critical repositories with zero change tolerance**: It's best to add these repositories _after_ validating the solution. + +## Pilot size by organization + +Once you've identified repositories that meet these criteria, determine the size of your pilot. The right pilot size balances gathering sufficient feedback with avoiding team overwhelm. + +| Organization size | Number of repositories | Recommendations | +|---|---|---| +| **Small** (under 100 developers) | 3-5 repositories | Start with your most critical projects. | +| **Medium** (100-500 developers) | 5-10 repositories | Select repositories across different teams, including a mix of high-activity and moderate-activity repositories. | +| **Large** (500+ developers) | 10-20 repositories | Ensure broad representation across the organization. Consider a phased approach with waves of repository additions. | + +## Before enabling your pilot + +Take these steps to set your pilot up for success. + +* Confirm repository owners agree to participate. Unwilling teams generate negative feedback that doesn't reflect actual product issues. +* Identify champions within each pilot team. Champions answer questions and keep feedback flowing. +* Document baseline metrics like commit frequency and contributor count. These baselines help you measure pilot impact. + +## Further reading + +* [Identify repositories for secret protection](https://support.github.com/product-guides/github-advanced-security-secret-protection/get-started/identify-repositories-for-secret-protection) in the GitHub Advanced Security product guides + +{% ifversion secret-risk-assessment %} + +## Next steps + +Now that you've selected your pilot repositories, review pricing and configure {% data variables.product.prodname_GH_secret_protection %}. See [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/protect-your-secrets). + +{% endif %} \ No newline at end of file diff --git a/content/code-security/concepts/security-at-scale/index.md b/content/code-security/concepts/security-at-scale/index.md index 011f6c549a31..1e716c92df02 100644 --- a/content/code-security/concepts/security-at-scale/index.md +++ b/content/code-security/concepts/security-at-scale/index.md @@ -8,6 +8,7 @@ versions: ghec: '*' contentType: concepts children: + - /best-practices-for-selecting-pilot-repositories - /about-enabling-security-features-at-scale - /about-security-overview - /about-security-campaigns diff --git a/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/protect-your-secrets.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/protect-your-secrets.md index 4d00daffb7ad..7a116a0ded4a 100644 --- a/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/protect-your-secrets.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/protect-your-secrets.md @@ -16,7 +16,10 @@ category: ## Prerequisites -Before you configure {% data variables.product.prodname_GH_secret_protection %}, you should run the free {% data variables.product.prodname_secret_risk_assessment %} to inform your enablement strategy. See [AUTOTITLE](/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/assess-your-secret-risk). +Before you configure {% data variables.product.prodname_GH_secret_protection %}: + +* Run the free {% data variables.product.prodname_secret_risk_assessment %} to inform your enablement strategy. See [AUTOTITLE](/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/assess-your-secret-risk). +* Review best practices for choosing pilot repositories. See [AUTOTITLE](/code-security/concepts/security-at-scale/best-practices-for-selecting-pilot-repositories). ## Configuring {% data variables.product.prodname_GH_secret_protection %} diff --git a/content/code-security/tutorials/secure-your-organization/interpreting-secret-risk-assessment-results.md b/content/code-security/tutorials/secure-your-organization/interpreting-secret-risk-assessment-results.md index 475b711c1c21..a993f7fb7339 100644 --- a/content/code-security/tutorials/secure-your-organization/interpreting-secret-risk-assessment-results.md +++ b/content/code-security/tutorials/secure-your-organization/interpreting-secret-risk-assessment-results.md @@ -93,4 +93,4 @@ Finally, look for the following indicators, which may require additional prevent ## Next steps -For stronger secret security and additional insights, {% data variables.product.github %} recommends enabling {% data variables.product.prodname_GH_secret_protection %} for all of your repositories. See [AUTOTITLE](/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/protect-your-secrets). +After understanding your secret exposure, select repositories for a {% data variables.product.prodname_GH_secret_protection %} pilot. See [AUTOTITLE](/code-security/concepts/security-at-scale/best-practices-for-selecting-pilot-repositories). From 41f1a192145904cb511ce9004ee4a452938cdf1b Mon Sep 17 00:00:00 2001 From: Thom Wong <101249231+supergranular@users.noreply.github.com> Date: Thu, 2 Apr 2026 13:33:55 +0200 Subject: [PATCH 05/11] updated naming to EDI and fixed a URL with a ghost header (#60588) Co-authored-by: Andy Hudson <36412516+andy-huddo-hudson@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> --- content/contributing/writing-for-github-docs/templates.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/contributing/writing-for-github-docs/templates.md b/content/contributing/writing-for-github-docs/templates.md index 71ae3512c204..e4616da42f58 100644 --- a/content/contributing/writing-for-github-docs/templates.md +++ b/content/contributing/writing-for-github-docs/templates.md @@ -109,9 +109,9 @@ Optionally, include a bulleted list of related articles the user can reference t -## Procedural article template +## How-to article template -Use the content model for full instructions and examples on how to write procedural content. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/procedural-content-type). +Use the content model for full instructions and examples on writing how-to content. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/how-to-content-type). @@ -127,7 +127,7 @@ versions: --- {% comment %} -Follow the guidelines in https://docs.github.com/contributing/writing-for-github-docs/content-model#procedural to write this article.-- > +Follow the guidelines in https://docs.github.com/contributing/writing-for-github-docs/content-model to write this article. Great intros give readers a quick understanding of what's in the article, so they can tell whether it's relevant to them before moving ahead. For more tips, see https://docs.github.com/contributing/writing-for-github-docs/content-model For product callout info, see https://github.com/github/docs/tree/main/content#product For product version instructions, see https://github.com/github/docs/tree/main/content#versioning From 889de32298ed2c1564ca4754bca81a992779e8d6 Mon Sep 17 00:00:00 2001 From: hubwriter Date: Thu, 2 Apr 2026 13:02:03 +0100 Subject: [PATCH 06/11] Copilot CLI: Document the built-in agents (#60467) Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- .../coding-agent/about-custom-agents.md | 49 +------------------ .../agents/copilot-cli/about-custom-agents.md | 47 ++++++++++++++++++ .../concepts/agents/copilot-cli/index.md | 1 + .../create-custom-agents-for-cli.md | 2 +- .../custom-agents-about-details.md | 40 +++++++++++++++ .../copilot-cli/custom-agents-about-intro.md | 7 +++ 6 files changed, 98 insertions(+), 48 deletions(-) create mode 100644 content/copilot/concepts/agents/copilot-cli/about-custom-agents.md create mode 100644 data/reusables/copilot/copilot-cli/custom-agents-about-details.md create mode 100644 data/reusables/copilot/copilot-cli/custom-agents-about-intro.md diff --git a/content/copilot/concepts/agents/coding-agent/about-custom-agents.md b/content/copilot/concepts/agents/coding-agent/about-custom-agents.md index 111aa7a2674c..c3dbdfb69f62 100644 --- a/content/copilot/concepts/agents/coding-agent/about-custom-agents.md +++ b/content/copilot/concepts/agents/coding-agent/about-custom-agents.md @@ -9,54 +9,9 @@ category: contentType: concepts --- -## About {% data variables.copilot.custom_agents_short %} +{% data reusables.copilot.copilot-cli.custom-agents-about-intro %} -{% data variables.copilot.custom_agents_caps_short %} are specialized versions of the {% data variables.product.prodname_copilot_short %} agent that you can tailor to your unique workflows, coding conventions, and use cases. They act like tailored teammates that follow your standards, use the right tools, and implement team-specific practices. You define these agents once instead of repeatedly providing the same instructions and context. - -You define {% data variables.copilot.custom_agents_short %} using Markdown files called {% data variables.copilot.agent_profiles %}. These files specify prompts, tools, and MCP servers. This allows you to encode your conventions, frameworks, and desired outcomes directly into {% data variables.product.prodname_copilot_short %}. - -The {% data variables.copilot.agent_profile %} defines the {% data variables.copilot.copilot_custom_agent_short %}'s behavior. When you assign the agent to a task or issue, it instantiates the {% data variables.copilot.copilot_custom_agent_short %}. - -## {% data variables.copilot.agent_profile_caps %} format - -{% data variables.copilot.agent_profiles_caps %} are Markdown files with YAML frontmatter. In their simplest form, they include: - -* **Name**: A unique identifier for the {% data variables.copilot.copilot_custom_agent_short %}. -* **Description**: Explains the agent's purpose and capabilities. -* **Prompt**: Custom instructions that define the agent's behavior and expertise. -* **Tools** (optional): Specific tools the agent can access. By default, agents can access all available tools, including built-in tools and MCP server tools. - -{% data variables.copilot.agent_profiles_caps %} can also include MCP server configurations using the `mcp-server` property. - -### Example {% data variables.copilot.agent_profile %} - -This example is a basic {% data variables.copilot.agent_profile %} with name, description, and prompt configured. - -```text ---- -name: readme-creator -description: Agent specializing in creating and improving README files ---- - -You are a documentation specialist focused on README files. Your scope is limited to README files or other related documentation files only - do not modify or analyze code files. - -Focus on the following instructions: -- Create and update README.md files with clear project descriptions -- Structure README sections logically: overview, installation, usage, contributing -- Write scannable content with proper headings and formatting -- Add appropriate badges, links, and navigation elements -- Use relative links (e.g., `docs/CONTRIBUTING.md`) instead of absolute URLs for files within the repository -- Make links descriptive and add alt text to images -``` - -## Where you can configure {% data variables.copilot.custom_agents_short %} - -You can define {% data variables.copilot.agent_profiles %} at different levels: - -* **Repository level**: Create `.github/agents/CUSTOM-AGENT-NAME.md` in your repository for project-specific agents. -* **Organization or enterprise level**: Create `/agents/CUSTOM-AGENT-NAME.md` in a `.github-private` repository for broader availability. - -For more information, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/prepare-for-custom-agents) and [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents). +{% data reusables.copilot.copilot-cli.custom-agents-about-details %} ## Where you can use {% data variables.copilot.custom_agents_short %} diff --git a/content/copilot/concepts/agents/copilot-cli/about-custom-agents.md b/content/copilot/concepts/agents/copilot-cli/about-custom-agents.md new file mode 100644 index 000000000000..e7156169d8e3 --- /dev/null +++ b/content/copilot/concepts/agents/copilot-cli/about-custom-agents.md @@ -0,0 +1,47 @@ +--- +title: About custom agents +shortTitle: Custom agents +intro: '{% data variables.copilot.custom_agents_caps_short %} enhance {% data variables.product.prodname_copilot_short %} with assistance tailored to your needs.' +versions: + feature: copilot +category: + - Learn about Copilot +contentType: concepts +--- + +{% data reusables.copilot.copilot-cli.custom-agents-about-intro %} + +In addition to any {% data variables.copilot.custom_agents_short %} you define yourself, {% data variables.product.prodname_copilot_short %} includes a set of pre-built {% data variables.copilot.custom_agents_short %}. See [Built-in agents](#built-in-agents). + +{% data reusables.copilot.copilot-cli.custom-agents-about-details %} + +## Built-in agents + +In addition to the main {% data variables.product.prodname_copilot_short %} agent, which processes your request when you submit a prompt, {% data variables.copilot.copilot_cli_short %} includes the following built-in agents which the main agent can run as subagents to assist with common development tasks. These agents are optimized for efficiency and accuracy, leveraging the capabilities of the underlying language models and tools to provide high-quality assistance in their respective domains. + +{% data variables.product.prodname_copilot_short %} will automatically use an appropriate built-in agent based on your prompt and the current context. For example, the prompt `How does authentication work in this codebase?` will typically trigger the Explore agent, and using the `/research` slash command will trigger the Research agent. + +* **explore** — A fast, lightweight codebase exploration agent. It uses code intelligence, grep, glob, view, and shell tools to search files and understand code structure. It will not change any files, so can be called in parallel to other subagents being run by the main {% data variables.product.prodname_copilot_short %} agent. It has read-only access to GitHub MCP server tools. + +* **task** — A command execution agent that runs development commands (tests, builds, linters, formatters, dependency installs) and reports results efficiently. It returns a brief summary on success, and full output on failure, keeping the main context clean. It has access to all of the tools the parent agent can use (excluding some that are not appropriate in a subagent context), with the same permissions granted or denied. + +* **general-purpose** — This agent essentially has all of the same capabilities as the main {% data variables.product.prodname_copilot_short %} agent. The main agent can run the general-purpose agent as a subagent to assist with any task that requires a separate context window, or to run in parallel when appropriate. + +* **code-review** — Reviews code changes with an extremely high signal-to-noise ratio. This agent analyzes staged/unstaged changes and branch diffs, surfacing only issues that genuinely matter: bugs, security vulnerabilities, race conditions, memory leaks, and logic errors. It never comments on style or formatting. It will not make any changes to files. + +* **research** — This agent operates as a staff-level software engineer and research specialist. It provides exhaustive, meticulously researched answers about codebases, APIs, libraries, and software architecture. It uses {% data variables.product.github %} search/exploration tools, web fetch/search, and local tools. Unlike the other agents, the research agent can only be invoked by using the `/research` slash command. It cannot be automatically triggered by the main agent. + +## Running agents as subagents + +One of the benefits of using custom agents you have defined yourself—or the built-in agents—is that the main {% data variables.product.prodname_copilot_short %} agent can run them as subagents with a separate context window. This means that your custom agent, or built-in agent, can focus on a specific subtask without cluttering the context window of the main agent. + +Where appropriate, tasks performed by subagents can be run in parallel, allowing the overall task to be completed more quickly. + +For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-cli/comparing-cli-features). + +## Next steps + +To create your own {% data variables.copilot.custom_agents_short %}, see: + +* [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/create-custom-agents-for-cli) +* [AUTOTITLE](/copilot/reference/customization-cheat-sheet) diff --git a/content/copilot/concepts/agents/copilot-cli/index.md b/content/copilot/concepts/agents/copilot-cli/index.md index de1510e4e8e6..3ec83c0899d5 100644 --- a/content/copilot/concepts/agents/copilot-cli/index.md +++ b/content/copilot/concepts/agents/copilot-cli/index.md @@ -7,6 +7,7 @@ versions: feature: copilot children: - /about-copilot-cli + - /about-custom-agents - /about-cli-plugins - /comparing-cli-features - /autopilot diff --git a/content/copilot/how-tos/copilot-cli/customize-copilot/create-custom-agents-for-cli.md b/content/copilot/how-tos/copilot-cli/customize-copilot/create-custom-agents-for-cli.md index 2fbb6f8c3c30..e449adefd7fe 100644 --- a/content/copilot/how-tos/copilot-cli/customize-copilot/create-custom-agents-for-cli.md +++ b/content/copilot/how-tos/copilot-cli/customize-copilot/create-custom-agents-for-cli.md @@ -20,7 +20,7 @@ When you prompt {% data variables.product.prodname_copilot_short %} to carry out Work performed by a {% data variables.copilot.copilot_custom_agent_short %} is carried out using a subagent, which is a temporary agent spun up to complete the task. The subagent has its own context window, which can be populated by information that is not relevant to the main agent. In this way, especially for larger tasks, parts of the work can be offloaded to {% data variables.copilot.custom_agents_short %}, without cluttering the main agent's context window. The main agent can then focus on higher-level planning and coordination. -For more information, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-custom-agents). +For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about-custom-agents). ## Creating a {% data variables.copilot.copilot_custom_agent_short %} diff --git a/data/reusables/copilot/copilot-cli/custom-agents-about-details.md b/data/reusables/copilot/copilot-cli/custom-agents-about-details.md new file mode 100644 index 000000000000..ebb037632a16 --- /dev/null +++ b/data/reusables/copilot/copilot-cli/custom-agents-about-details.md @@ -0,0 +1,40 @@ +## {% data variables.copilot.agent_profile_caps %} format + +{% data variables.copilot.agent_profiles_caps %} are Markdown files with YAML frontmatter. In their simplest form, they include: + +* **Name** (optional): A display name for the {% data variables.copilot.copilot_custom_agent_short %}. If omitted, the agent's filename is used as its identifier and default display name. +* **Description**: Explains the agent's purpose and capabilities. +* **Prompt**: Custom instructions that define the agent's behavior and expertise. +* **Tools** (optional): Specific tools the agent can access. By default, agents can access all available tools, including built-in tools, and MCP server tools. + +{% data variables.copilot.agent_profiles_caps %} can also include MCP server configurations using the `mcp-servers` property. + +### Example {% data variables.copilot.agent_profile %} + +This example is a basic {% data variables.copilot.agent_profile %} with name, description, and prompt configured. + +```text +--- +name: readme-creator +description: Agent specializing in creating and improving README files +--- + +You are a documentation specialist focused on README files. Your scope is limited to README files or other related documentation files only - do not modify or analyze code files. + +Focus on the following instructions: +- Create and update README.md files with clear project descriptions +- Structure README sections logically: overview, installation, usage, contributing +- Write scannable content with proper headings and formatting +- Add appropriate badges, links, and navigation elements +- Use relative links (e.g., `docs/CONTRIBUTING.md`) instead of absolute URLs for files within the repository +- Make links descriptive and add alt text to images +``` + +## Where you can configure {% data variables.copilot.custom_agents_short %} + +You can define {% data variables.copilot.agent_profiles %} at different levels: + +* **Repository level**: Create `.github/agents/CUSTOM-AGENT-NAME.md` in your repository for project-specific agents. +* **Organization or enterprise level**: Create `/agents/CUSTOM-AGENT-NAME.md` in a `.github-private` repository for broader availability. + +For more information, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/prepare-for-custom-agents) and [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents). diff --git a/data/reusables/copilot/copilot-cli/custom-agents-about-intro.md b/data/reusables/copilot/copilot-cli/custom-agents-about-intro.md new file mode 100644 index 000000000000..1a3c06c8facb --- /dev/null +++ b/data/reusables/copilot/copilot-cli/custom-agents-about-intro.md @@ -0,0 +1,7 @@ +## About {% data variables.copilot.custom_agents_short %} + +{% data variables.copilot.custom_agents_caps_short %} are specialized versions of the {% data variables.product.prodname_copilot_short %} agent that you can tailor to your unique workflows, coding conventions, and use cases. They act like tailored teammates that follow your standards, use the right tools, and implement team-specific practices. You define these agents once instead of repeatedly providing the same instructions and context. + +You define {% data variables.copilot.custom_agents_short %} using Markdown files called {% data variables.copilot.agent_profiles %}. These files specify prompts, tools, and MCP servers. This allows you to encode your conventions, frameworks, and desired outcomes directly into {% data variables.product.prodname_copilot_short %}. + +The {% data variables.copilot.agent_profile %} defines the {% data variables.copilot.copilot_custom_agent_short %}'s behavior. When you assign the agent to a task or issue, it instantiates the {% data variables.copilot.copilot_custom_agent_short %}. From 81adfb25af30bd677721412e97ad0e925928e71b Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Thu, 2 Apr 2026 05:07:31 -0700 Subject: [PATCH 07/11] Update OpenAPI Description (#60568) Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com> --- .../fpt-2022-11-28/server-to-server-rest.json | 8 - .../fpt-2022-11-28/user-to-server-rest.json | 8 - .../fpt-2026-03-10/server-to-server-rest.json | 8 - .../fpt-2026-03-10/user-to-server-rest.json | 8 - .../server-to-server-rest.json | 8 - .../ghec-2022-11-28/user-to-server-rest.json | 8 - .../server-to-server-rest.json | 8 - .../ghec-2026-03-10/user-to-server-rest.json | 8 - .../server-to-server-rest.json | 8 - .../user-to-server-rest.json | 8 - .../server-to-server-rest.json | 8 - .../user-to-server-rest.json | 8 - .../server-to-server-rest.json | 8 - .../user-to-server-rest.json | 8 - src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/credentials.json | 9 +- src/rest/data/fpt-2022-11-28/releases.json | 2 +- src/rest/data/fpt-2022-11-28/repos.json | 112 +- src/rest/data/fpt-2022-11-28/search.json | 2815 ++++++++++++++++- src/rest/data/fpt-2026-03-10/credentials.json | 9 +- src/rest/data/fpt-2026-03-10/releases.json | 2 +- src/rest/data/fpt-2026-03-10/repos.json | 112 +- src/rest/data/fpt-2026-03-10/search.json | 2680 +++++++++++++++- .../data/ghec-2022-11-28/credentials.json | 9 +- src/rest/data/ghec-2022-11-28/releases.json | 2 +- src/rest/data/ghec-2022-11-28/repos.json | 112 +- src/rest/data/ghec-2022-11-28/search.json | 2815 ++++++++++++++++- .../data/ghec-2026-03-10/credentials.json | 9 +- src/rest/data/ghec-2026-03-10/releases.json | 2 +- src/rest/data/ghec-2026-03-10/repos.json | 112 +- src/rest/data/ghec-2026-03-10/search.json | 2680 +++++++++++++++- .../data/ghes-3.14-2022-11-28/releases.json | 2 +- .../data/ghes-3.14-2022-11-28/search.json | 2809 +++++++++++++++- .../data/ghes-3.15-2022-11-28/releases.json | 2 +- .../data/ghes-3.15-2022-11-28/search.json | 2815 ++++++++++++++++- .../data/ghes-3.16-2022-11-28/releases.json | 2 +- .../data/ghes-3.16-2022-11-28/search.json | 2815 ++++++++++++++++- .../data/ghes-3.17-2022-11-28/releases.json | 2 +- .../data/ghes-3.17-2022-11-28/search.json | 2815 ++++++++++++++++- .../ghes-3.18-2022-11-28/credentials.json | 9 +- .../data/ghes-3.18-2022-11-28/releases.json | 2 +- .../data/ghes-3.18-2022-11-28/search.json | 2815 ++++++++++++++++- .../ghes-3.19-2022-11-28/credentials.json | 9 +- .../data/ghes-3.19-2022-11-28/releases.json | 2 +- .../data/ghes-3.19-2022-11-28/search.json | 2815 ++++++++++++++++- .../ghes-3.20-2022-11-28/credentials.json | 9 +- .../data/ghes-3.20-2022-11-28/releases.json | 2 +- .../data/ghes-3.20-2022-11-28/search.json | 2815 ++++++++++++++++- src/rest/lib/config.json | 2 +- src/webhooks/lib/config.json | 2 +- 50 files changed, 30841 insertions(+), 499 deletions(-) diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json index 9b6852dd9a9c..5c7bdb03c6d3 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json @@ -2271,14 +2271,6 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], - "credentials": [ - { - "slug": "revoke-a-list-of-credentials", - "subcategory": "revoke", - "verb": "post", - "requestPath": "/credentials/revoke" - } - ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-organization", diff --git a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json index 747b878ea73d..2f70d14ccbf8 100644 --- a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json @@ -2537,14 +2537,6 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], - "credentials": [ - { - "slug": "revoke-a-list-of-credentials", - "subcategory": "revoke", - "verb": "post", - "requestPath": "/credentials/revoke" - } - ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-organization", diff --git a/src/github-apps/data/fpt-2026-03-10/server-to-server-rest.json b/src/github-apps/data/fpt-2026-03-10/server-to-server-rest.json index 9b6852dd9a9c..5c7bdb03c6d3 100644 --- a/src/github-apps/data/fpt-2026-03-10/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2026-03-10/server-to-server-rest.json @@ -2271,14 +2271,6 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], - "credentials": [ - { - "slug": "revoke-a-list-of-credentials", - "subcategory": "revoke", - "verb": "post", - "requestPath": "/credentials/revoke" - } - ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-organization", diff --git a/src/github-apps/data/fpt-2026-03-10/user-to-server-rest.json b/src/github-apps/data/fpt-2026-03-10/user-to-server-rest.json index 747b878ea73d..2f70d14ccbf8 100644 --- a/src/github-apps/data/fpt-2026-03-10/user-to-server-rest.json +++ b/src/github-apps/data/fpt-2026-03-10/user-to-server-rest.json @@ -2537,14 +2537,6 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], - "credentials": [ - { - "slug": "revoke-a-list-of-credentials", - "subcategory": "revoke", - "verb": "post", - "requestPath": "/credentials/revoke" - } - ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-organization", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index 07ba67a69ea5..a78ac01c33d9 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -2345,14 +2345,6 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], - "credentials": [ - { - "slug": "revoke-a-list-of-credentials", - "subcategory": "revoke", - "verb": "post", - "requestPath": "/credentials/revoke" - } - ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-organization", diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json index 80a3c8eb2e96..be1a63455654 100644 --- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json @@ -2593,14 +2593,6 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], - "credentials": [ - { - "slug": "revoke-a-list-of-credentials", - "subcategory": "revoke", - "verb": "post", - "requestPath": "/credentials/revoke" - } - ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-organization", diff --git a/src/github-apps/data/ghec-2026-03-10/server-to-server-rest.json b/src/github-apps/data/ghec-2026-03-10/server-to-server-rest.json index 07ba67a69ea5..a78ac01c33d9 100644 --- a/src/github-apps/data/ghec-2026-03-10/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2026-03-10/server-to-server-rest.json @@ -2345,14 +2345,6 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], - "credentials": [ - { - "slug": "revoke-a-list-of-credentials", - "subcategory": "revoke", - "verb": "post", - "requestPath": "/credentials/revoke" - } - ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-organization", diff --git a/src/github-apps/data/ghec-2026-03-10/user-to-server-rest.json b/src/github-apps/data/ghec-2026-03-10/user-to-server-rest.json index 80a3c8eb2e96..be1a63455654 100644 --- a/src/github-apps/data/ghec-2026-03-10/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2026-03-10/user-to-server-rest.json @@ -2593,14 +2593,6 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], - "credentials": [ - { - "slug": "revoke-a-list-of-credentials", - "subcategory": "revoke", - "verb": "post", - "requestPath": "/credentials/revoke" - } - ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-organization", diff --git a/src/github-apps/data/ghes-3.18-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.18-2022-11-28/server-to-server-rest.json index d6430146054e..71e1916589f7 100644 --- a/src/github-apps/data/ghes-3.18-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.18-2022-11-28/server-to-server-rest.json @@ -1571,14 +1571,6 @@ "requestPath": "/repos/{owner}/{repo}/statuses/{sha}" } ], - "credentials": [ - { - "slug": "revoke-a-list-of-credentials", - "subcategory": "revoke", - "verb": "post", - "requestPath": "/credentials/revoke" - } - ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-organization", diff --git a/src/github-apps/data/ghes-3.18-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.18-2022-11-28/user-to-server-rest.json index f6c2136548bd..fdc6965992f3 100644 --- a/src/github-apps/data/ghes-3.18-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.18-2022-11-28/user-to-server-rest.json @@ -1619,14 +1619,6 @@ "requestPath": "/repos/{owner}/{repo}/statuses/{sha}" } ], - "credentials": [ - { - "slug": "revoke-a-list-of-credentials", - "subcategory": "revoke", - "verb": "post", - "requestPath": "/credentials/revoke" - } - ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-organization", diff --git a/src/github-apps/data/ghes-3.19-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.19-2022-11-28/server-to-server-rest.json index 5615837f1355..520a542fa684 100644 --- a/src/github-apps/data/ghes-3.19-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.19-2022-11-28/server-to-server-rest.json @@ -1703,14 +1703,6 @@ "requestPath": "/repos/{owner}/{repo}/statuses/{sha}" } ], - "credentials": [ - { - "slug": "revoke-a-list-of-credentials", - "subcategory": "revoke", - "verb": "post", - "requestPath": "/credentials/revoke" - } - ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-organization", diff --git a/src/github-apps/data/ghes-3.19-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.19-2022-11-28/user-to-server-rest.json index 120d743caffd..f63e1d84d659 100644 --- a/src/github-apps/data/ghes-3.19-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.19-2022-11-28/user-to-server-rest.json @@ -1751,14 +1751,6 @@ "requestPath": "/repos/{owner}/{repo}/statuses/{sha}" } ], - "credentials": [ - { - "slug": "revoke-a-list-of-credentials", - "subcategory": "revoke", - "verb": "post", - "requestPath": "/credentials/revoke" - } - ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-organization", diff --git a/src/github-apps/data/ghes-3.20-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.20-2022-11-28/server-to-server-rest.json index a9465c28875b..a0b762214ee2 100644 --- a/src/github-apps/data/ghes-3.20-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.20-2022-11-28/server-to-server-rest.json @@ -1703,14 +1703,6 @@ "requestPath": "/repos/{owner}/{repo}/statuses/{sha}" } ], - "credentials": [ - { - "slug": "revoke-a-list-of-credentials", - "subcategory": "revoke", - "verb": "post", - "requestPath": "/credentials/revoke" - } - ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-organization", diff --git a/src/github-apps/data/ghes-3.20-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.20-2022-11-28/user-to-server-rest.json index b5572c31829f..b7c19d2508e0 100644 --- a/src/github-apps/data/ghes-3.20-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.20-2022-11-28/user-to-server-rest.json @@ -1751,14 +1751,6 @@ "requestPath": "/repos/{owner}/{repo}/statuses/{sha}" } ], - "credentials": [ - { - "slug": "revoke-a-list-of-credentials", - "subcategory": "revoke", - "verb": "post", - "requestPath": "/credentials/revoke" - } - ], "dependabot": [ { "slug": "lists-the-repositories-dependabot-can-access-in-an-organization", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 1ddb4f602f79..4976f135f335 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "79f95939a0e167076fd369c97ad924f70cf65b37" + "sha": "f8524e666767de6a6784abf509992ad962dd7762" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/credentials.json b/src/rest/data/fpt-2022-11-28/credentials.json index 5044ec960d0a..860cafc0b2e3 100644 --- a/src/rest/data/fpt-2022-11-28/credentials.json +++ b/src/rest/data/fpt-2022-11-28/credentials.json @@ -60,11 +60,10 @@ ], "previews": [], "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] } } ] diff --git a/src/rest/data/fpt-2022-11-28/releases.json b/src/rest/data/fpt-2022-11-28/releases.json index 03679457968d..889eb523b3ef 100644 --- a/src/rest/data/fpt-2022-11-28/releases.json +++ b/src/rest/data/fpt-2022-11-28/releases.json @@ -3461,7 +3461,7 @@ "false", "legacy" ], - "default": true + "default": "true" }, { "type": "string", diff --git a/src/rest/data/fpt-2022-11-28/repos.json b/src/rest/data/fpt-2022-11-28/repos.json index 60a88480c6c6..d669253c1d79 100644 --- a/src/rest/data/fpt-2022-11-28/repos.json +++ b/src/rest/data/fpt-2022-11-28/repos.json @@ -25686,67 +25686,65 @@ { "request": { "contentType": "application/json", - "description": "Example of a request body", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "value": { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] } } }, diff --git a/src/rest/data/fpt-2022-11-28/search.json b/src/rest/data/fpt-2022-11-28/search.json index 55312feb7b30..9383c6cfde82 100644 --- a/src/rest/data/fpt-2022-11-28/search.json +++ b/src/rest/data/fpt-2022-11-28/search.json @@ -2396,6 +2396,19 @@ "schema": { "type": "string" } + }, + { + "name": "search_type", + "description": "

The type of search to perform on issues. When not specified, the default is lexical search.

\n
    \n
  • semantic — performs a pure semantic (vector) search using embedding-based understanding.
    • \n
  • hybrid — combines semantic search with lexical search for best results.
    • \n
\n

Semantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (/search/issues).

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "semantic", + "hybrid" + ] + } } ], "bodyParameters": [], @@ -2403,16 +2416,17 @@ "codeExamples": [ { "request": { - "description": "Example", + "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response

", + "description": "

Hybrid search response

", "example": { "total_count": 280, "incomplete_results": false, + "search_type": "hybrid", "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", @@ -5267,16 +5281,2797 @@ } } } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" }, { - "httpStatusCode": "304", - "description": "

Not modified

" + "request": { + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Hybrid search with lexical fallback

", + "example": { + "total_count": 280, + "incomplete_results": false, + "search_type": "lexical", + "lexical_fallback_reason": [ + "quoted_text" + ], + "items": [ + "..." + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items", + "search_type" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "title": "Issue Search Result Item", + "description": "Issue Search Result Item", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "The name of the option", + "type": "string" + }, + "color": { + "description": "The color of the option", + "type": "string" + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "type": "string" + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "body": { + "type": "string" + }, + "score": { + "type": "number" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "draft": { + "type": "boolean" + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "full_name": { + "type": "string" + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "spdx_id": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean" + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean" + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean" + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "pinned_comment": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time" + }, + "pinned_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "pinned_at", + "pinned_by" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at", + "score" + ] + } + }, + "search_type": { + "type": "string", + "description": "The type of search that was performed. Possible values are `lexical`, `semantic`, or `hybrid`.", + "enum": [ + "lexical", + "semantic", + "hybrid" + ] + }, + "lexical_fallback_reason": { + "type": "array", + "description": "When a semantic or hybrid search falls back to lexical search, this field contains the reasons for the fallback. Only present when a fallback occurred.", + "items": { + "type": "string", + "enum": [ + "no_text_terms", + "quoted_text", + "non_issue_target", + "or_boolean_not_supported", + "no_accessible_repos", + "server_error", + "only_non_semantic_fields_requested" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

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

Not modified

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

Requires authentication

" }, { "httpStatusCode": "403", diff --git a/src/rest/data/fpt-2026-03-10/credentials.json b/src/rest/data/fpt-2026-03-10/credentials.json index 5044ec960d0a..860cafc0b2e3 100644 --- a/src/rest/data/fpt-2026-03-10/credentials.json +++ b/src/rest/data/fpt-2026-03-10/credentials.json @@ -60,11 +60,10 @@ ], "previews": [], "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] } } ] diff --git a/src/rest/data/fpt-2026-03-10/releases.json b/src/rest/data/fpt-2026-03-10/releases.json index 03679457968d..889eb523b3ef 100644 --- a/src/rest/data/fpt-2026-03-10/releases.json +++ b/src/rest/data/fpt-2026-03-10/releases.json @@ -3461,7 +3461,7 @@ "false", "legacy" ], - "default": true + "default": "true" }, { "type": "string", diff --git a/src/rest/data/fpt-2026-03-10/repos.json b/src/rest/data/fpt-2026-03-10/repos.json index f1da4edc9739..cc391d726f20 100644 --- a/src/rest/data/fpt-2026-03-10/repos.json +++ b/src/rest/data/fpt-2026-03-10/repos.json @@ -25396,67 +25396,65 @@ { "request": { "contentType": "application/json", - "description": "Example of a request body", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "value": { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] } } }, diff --git a/src/rest/data/fpt-2026-03-10/search.json b/src/rest/data/fpt-2026-03-10/search.json index 31c5ae84e644..48e3fd1319df 100644 --- a/src/rest/data/fpt-2026-03-10/search.json +++ b/src/rest/data/fpt-2026-03-10/search.json @@ -2390,6 +2390,19 @@ "schema": { "type": "string" } + }, + { + "name": "search_type", + "description": "

The type of search to perform on issues. When not specified, the default is lexical search.

\n
    \n
  • semantic — performs a pure semantic (vector) search using embedding-based understanding.
    • \n
  • hybrid — combines semantic search with lexical search for best results.
    • \n
\n

Semantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (/search/issues).

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "semantic", + "hybrid" + ] + } } ], "bodyParameters": [], @@ -2397,16 +2410,17 @@ "codeExamples": [ { "request": { - "description": "Example", + "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response

", + "description": "

Hybrid search response

", "example": { "total_count": 280, "incomplete_results": false, + "search_type": "hybrid", "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", @@ -5126,16 +5140,2662 @@ } } } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" }, { - "httpStatusCode": "304", - "description": "

Not modified

" + "request": { + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Hybrid search with lexical fallback

", + "example": { + "total_count": 280, + "incomplete_results": false, + "search_type": "lexical", + "lexical_fallback_reason": [ + "quoted_text" + ], + "items": [ + "..." + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items", + "search_type" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "title": "Issue Search Result Item", + "description": "Issue Search Result Item", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "The name of the option", + "type": "string" + }, + "color": { + "description": "The color of the option", + "type": "string" + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "type": "string" + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "body": { + "type": "string" + }, + "score": { + "type": "number" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "draft": { + "type": "boolean" + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "full_name": { + "type": "string" + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "spdx_id": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean" + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean" + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean" + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "starred_at": { + "type": "string" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "pinned_comment": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time" + }, + "pinned_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "pinned_at", + "pinned_by" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at", + "score" + ] + } + }, + "search_type": { + "type": "string", + "description": "The type of search that was performed. Possible values are `lexical`, `semantic`, or `hybrid`.", + "enum": [ + "lexical", + "semantic", + "hybrid" + ] + }, + "lexical_fallback_reason": { + "type": "array", + "description": "When a semantic or hybrid search falls back to lexical search, this field contains the reasons for the fallback. Only present when a fallback occurred.", + "items": { + "type": "string", + "enum": [ + "no_text_terms", + "quoted_text", + "non_issue_target", + "or_boolean_not_supported", + "no_accessible_repos", + "server_error", + "only_non_semantic_fields_requested" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

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

Not modified

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

Requires authentication

" }, { "httpStatusCode": "403", diff --git a/src/rest/data/ghec-2022-11-28/credentials.json b/src/rest/data/ghec-2022-11-28/credentials.json index 5044ec960d0a..860cafc0b2e3 100644 --- a/src/rest/data/ghec-2022-11-28/credentials.json +++ b/src/rest/data/ghec-2022-11-28/credentials.json @@ -60,11 +60,10 @@ ], "previews": [], "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] } } ] diff --git a/src/rest/data/ghec-2022-11-28/releases.json b/src/rest/data/ghec-2022-11-28/releases.json index 19b30657f047..7a288b88cb21 100644 --- a/src/rest/data/ghec-2022-11-28/releases.json +++ b/src/rest/data/ghec-2022-11-28/releases.json @@ -3461,7 +3461,7 @@ "false", "legacy" ], - "default": true + "default": "true" }, { "type": "string", diff --git a/src/rest/data/ghec-2022-11-28/repos.json b/src/rest/data/ghec-2022-11-28/repos.json index 485eaea9f53c..404f776fa5a6 100644 --- a/src/rest/data/ghec-2022-11-28/repos.json +++ b/src/rest/data/ghec-2022-11-28/repos.json @@ -25812,67 +25812,65 @@ { "request": { "contentType": "application/json", - "description": "Example of a request body", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "value": { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] } } }, diff --git a/src/rest/data/ghec-2022-11-28/search.json b/src/rest/data/ghec-2022-11-28/search.json index 0a683ac1002e..cfd883a5a4ac 100644 --- a/src/rest/data/ghec-2022-11-28/search.json +++ b/src/rest/data/ghec-2022-11-28/search.json @@ -2420,6 +2420,19 @@ "schema": { "type": "string" } + }, + { + "name": "search_type", + "description": "

The type of search to perform on issues. When not specified, the default is lexical search.

\n
    \n
  • semantic — performs a pure semantic (vector) search using embedding-based understanding.
    • \n
  • hybrid — combines semantic search with lexical search for best results.
    • \n
\n

Semantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (/search/issues).

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "semantic", + "hybrid" + ] + } } ], "bodyParameters": [], @@ -2427,16 +2440,17 @@ "codeExamples": [ { "request": { - "description": "Example", + "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response

", + "description": "

Hybrid search response

", "example": { "total_count": 280, "incomplete_results": false, + "search_type": "hybrid", "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", @@ -5291,16 +5305,2797 @@ } } } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" }, { - "httpStatusCode": "304", - "description": "

Not modified

" + "request": { + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Hybrid search with lexical fallback

", + "example": { + "total_count": 280, + "incomplete_results": false, + "search_type": "lexical", + "lexical_fallback_reason": [ + "quoted_text" + ], + "items": [ + "..." + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items", + "search_type" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "title": "Issue Search Result Item", + "description": "Issue Search Result Item", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "The name of the option", + "type": "string" + }, + "color": { + "description": "The color of the option", + "type": "string" + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "type": "string" + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "body": { + "type": "string" + }, + "score": { + "type": "number" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "draft": { + "type": "boolean" + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "full_name": { + "type": "string" + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "spdx_id": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean" + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean" + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean" + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "pinned_comment": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time" + }, + "pinned_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "pinned_at", + "pinned_by" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at", + "score" + ] + } + }, + "search_type": { + "type": "string", + "description": "The type of search that was performed. Possible values are `lexical`, `semantic`, or `hybrid`.", + "enum": [ + "lexical", + "semantic", + "hybrid" + ] + }, + "lexical_fallback_reason": { + "type": "array", + "description": "When a semantic or hybrid search falls back to lexical search, this field contains the reasons for the fallback. Only present when a fallback occurred.", + "items": { + "type": "string", + "enum": [ + "no_text_terms", + "quoted_text", + "non_issue_target", + "or_boolean_not_supported", + "no_accessible_repos", + "server_error", + "only_non_semantic_fields_requested" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

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

Not modified

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

Requires authentication

" }, { "httpStatusCode": "403", diff --git a/src/rest/data/ghec-2026-03-10/credentials.json b/src/rest/data/ghec-2026-03-10/credentials.json index 5044ec960d0a..860cafc0b2e3 100644 --- a/src/rest/data/ghec-2026-03-10/credentials.json +++ b/src/rest/data/ghec-2026-03-10/credentials.json @@ -60,11 +60,10 @@ ], "previews": [], "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] } } ] diff --git a/src/rest/data/ghec-2026-03-10/releases.json b/src/rest/data/ghec-2026-03-10/releases.json index 19b30657f047..7a288b88cb21 100644 --- a/src/rest/data/ghec-2026-03-10/releases.json +++ b/src/rest/data/ghec-2026-03-10/releases.json @@ -3461,7 +3461,7 @@ "false", "legacy" ], - "default": true + "default": "true" }, { "type": "string", diff --git a/src/rest/data/ghec-2026-03-10/repos.json b/src/rest/data/ghec-2026-03-10/repos.json index 6c3b4239732c..1fb68b7692a4 100644 --- a/src/rest/data/ghec-2026-03-10/repos.json +++ b/src/rest/data/ghec-2026-03-10/repos.json @@ -25522,67 +25522,65 @@ { "request": { "contentType": "application/json", - "description": "Example of a request body", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "value": { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] } } }, diff --git a/src/rest/data/ghec-2026-03-10/search.json b/src/rest/data/ghec-2026-03-10/search.json index 91beab99321e..97277cec471a 100644 --- a/src/rest/data/ghec-2026-03-10/search.json +++ b/src/rest/data/ghec-2026-03-10/search.json @@ -2414,6 +2414,19 @@ "schema": { "type": "string" } + }, + { + "name": "search_type", + "description": "

The type of search to perform on issues. When not specified, the default is lexical search.

\n
    \n
  • semantic — performs a pure semantic (vector) search using embedding-based understanding.
    • \n
  • hybrid — combines semantic search with lexical search for best results.
    • \n
\n

Semantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (/search/issues).

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "semantic", + "hybrid" + ] + } } ], "bodyParameters": [], @@ -2421,16 +2434,17 @@ "codeExamples": [ { "request": { - "description": "Example", + "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response

", + "description": "

Hybrid search response

", "example": { "total_count": 280, "incomplete_results": false, + "search_type": "hybrid", "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", @@ -5150,16 +5164,2662 @@ } } } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" }, { - "httpStatusCode": "304", - "description": "

Not modified

" + "request": { + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Hybrid search with lexical fallback

", + "example": { + "total_count": 280, + "incomplete_results": false, + "search_type": "lexical", + "lexical_fallback_reason": [ + "quoted_text" + ], + "items": [ + "..." + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items", + "search_type" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "title": "Issue Search Result Item", + "description": "Issue Search Result Item", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "The name of the option", + "type": "string" + }, + "color": { + "description": "The color of the option", + "type": "string" + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "type": "string" + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "body": { + "type": "string" + }, + "score": { + "type": "number" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "draft": { + "type": "boolean" + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "full_name": { + "type": "string" + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "spdx_id": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean" + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean" + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean" + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "starred_at": { + "type": "string" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "pinned_comment": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time" + }, + "pinned_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "pinned_at", + "pinned_by" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at", + "score" + ] + } + }, + "search_type": { + "type": "string", + "description": "The type of search that was performed. Possible values are `lexical`, `semantic`, or `hybrid`.", + "enum": [ + "lexical", + "semantic", + "hybrid" + ] + }, + "lexical_fallback_reason": { + "type": "array", + "description": "When a semantic or hybrid search falls back to lexical search, this field contains the reasons for the fallback. Only present when a fallback occurred.", + "items": { + "type": "string", + "enum": [ + "no_text_terms", + "quoted_text", + "non_issue_target", + "or_boolean_not_supported", + "no_accessible_repos", + "server_error", + "only_non_semantic_fields_requested" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

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

Not modified

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

Requires authentication

" }, { "httpStatusCode": "403", diff --git a/src/rest/data/ghes-3.14-2022-11-28/releases.json b/src/rest/data/ghes-3.14-2022-11-28/releases.json index d9db995d3a8d..edd0e53ee918 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/releases.json +++ b/src/rest/data/ghes-3.14-2022-11-28/releases.json @@ -3427,7 +3427,7 @@ "false", "legacy" ], - "default": true + "default": "true" } ], "descriptionHTML": "

Users with push access to the repository can edit a release.

", diff --git a/src/rest/data/ghes-3.14-2022-11-28/search.json b/src/rest/data/ghes-3.14-2022-11-28/search.json index dca69031c09d..76de00c37907 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/search.json +++ b/src/rest/data/ghes-3.14-2022-11-28/search.json @@ -2199,6 +2199,19 @@ "schema": { "type": "string" } + }, + { + "name": "search_type", + "description": "

The type of search to perform on issues. When not specified, the default is lexical search.

\n
    \n
  • semantic — performs a pure semantic (vector) search using embedding-based understanding.
    • \n
  • hybrid — combines semantic search with lexical search for best results.
    • \n
\n

Semantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (/search/issues).

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "semantic", + "hybrid" + ] + } } ], "bodyParameters": [], @@ -2206,16 +2219,17 @@ "codeExamples": [ { "request": { - "description": "Example", + "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response

", + "description": "

Hybrid search response

", "example": { "total_count": 280, "incomplete_results": false, + "search_type": "hybrid", "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", @@ -5064,16 +5078,2791 @@ } } } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" }, { - "httpStatusCode": "304", - "description": "

Not modified

" + "request": { + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Hybrid search with lexical fallback

", + "example": { + "total_count": 280, + "incomplete_results": false, + "search_type": "lexical", + "lexical_fallback_reason": [ + "quoted_text" + ], + "items": [ + "..." + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items", + "search_type" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "title": "Issue Search Result Item", + "description": "Issue Search Result Item", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "The name of the option", + "type": "string" + }, + "color": { + "description": "The color of the option", + "type": "string" + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "type": "string" + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "body": { + "type": "string" + }, + "score": { + "type": "number" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "draft": { + "type": "boolean" + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "full_name": { + "type": "string" + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "spdx_id": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean" + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean" + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean" + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "pinned_comment": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time" + }, + "pinned_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "pinned_at", + "pinned_by" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at", + "score" + ] + } + }, + "search_type": { + "type": "string", + "description": "The type of search that was performed. Possible values are `lexical`, `semantic`, or `hybrid`.", + "enum": [ + "lexical", + "semantic", + "hybrid" + ] + }, + "lexical_fallback_reason": { + "type": "array", + "description": "When a semantic or hybrid search falls back to lexical search, this field contains the reasons for the fallback. Only present when a fallback occurred.", + "items": { + "type": "string", + "enum": [ + "no_text_terms", + "quoted_text", + "non_issue_target", + "or_boolean_not_supported", + "no_accessible_repos", + "server_error", + "only_non_semantic_fields_requested" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

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

Not modified

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

Requires authentication

" }, { "httpStatusCode": "403", diff --git a/src/rest/data/ghes-3.15-2022-11-28/releases.json b/src/rest/data/ghes-3.15-2022-11-28/releases.json index 04984b676845..fa54c7e595f5 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/releases.json +++ b/src/rest/data/ghes-3.15-2022-11-28/releases.json @@ -3427,7 +3427,7 @@ "false", "legacy" ], - "default": true + "default": "true" } ], "descriptionHTML": "

Users with push access to the repository can edit a release.

", diff --git a/src/rest/data/ghes-3.15-2022-11-28/search.json b/src/rest/data/ghes-3.15-2022-11-28/search.json index 7500a407963f..bc9ba1060a9c 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/search.json +++ b/src/rest/data/ghes-3.15-2022-11-28/search.json @@ -2223,6 +2223,19 @@ "schema": { "type": "string" } + }, + { + "name": "search_type", + "description": "

The type of search to perform on issues. When not specified, the default is lexical search.

\n
    \n
  • semantic — performs a pure semantic (vector) search using embedding-based understanding.
    • \n
  • hybrid — combines semantic search with lexical search for best results.
    • \n
\n

Semantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (/search/issues).

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "semantic", + "hybrid" + ] + } } ], "bodyParameters": [], @@ -2230,16 +2243,17 @@ "codeExamples": [ { "request": { - "description": "Example", + "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response

", + "description": "

Hybrid search response

", "example": { "total_count": 280, "incomplete_results": false, + "search_type": "hybrid", "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", @@ -5094,16 +5108,2797 @@ } } } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" }, { - "httpStatusCode": "304", - "description": "

Not modified

" + "request": { + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Hybrid search with lexical fallback

", + "example": { + "total_count": 280, + "incomplete_results": false, + "search_type": "lexical", + "lexical_fallback_reason": [ + "quoted_text" + ], + "items": [ + "..." + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items", + "search_type" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "title": "Issue Search Result Item", + "description": "Issue Search Result Item", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "The name of the option", + "type": "string" + }, + "color": { + "description": "The color of the option", + "type": "string" + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "type": "string" + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "body": { + "type": "string" + }, + "score": { + "type": "number" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "draft": { + "type": "boolean" + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "full_name": { + "type": "string" + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "spdx_id": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean" + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean" + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean" + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "pinned_comment": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time" + }, + "pinned_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "pinned_at", + "pinned_by" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at", + "score" + ] + } + }, + "search_type": { + "type": "string", + "description": "The type of search that was performed. Possible values are `lexical`, `semantic`, or `hybrid`.", + "enum": [ + "lexical", + "semantic", + "hybrid" + ] + }, + "lexical_fallback_reason": { + "type": "array", + "description": "When a semantic or hybrid search falls back to lexical search, this field contains the reasons for the fallback. Only present when a fallback occurred.", + "items": { + "type": "string", + "enum": [ + "no_text_terms", + "quoted_text", + "non_issue_target", + "or_boolean_not_supported", + "no_accessible_repos", + "server_error", + "only_non_semantic_fields_requested" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

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

Not modified

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

Requires authentication

" }, { "httpStatusCode": "403", diff --git a/src/rest/data/ghes-3.16-2022-11-28/releases.json b/src/rest/data/ghes-3.16-2022-11-28/releases.json index 831c400c1690..ba6c54485036 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/releases.json +++ b/src/rest/data/ghes-3.16-2022-11-28/releases.json @@ -3427,7 +3427,7 @@ "false", "legacy" ], - "default": true + "default": "true" } ], "descriptionHTML": "

Users with push access to the repository can edit a release.

", diff --git a/src/rest/data/ghes-3.16-2022-11-28/search.json b/src/rest/data/ghes-3.16-2022-11-28/search.json index 9761a762bc7c..de62682758e2 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/search.json +++ b/src/rest/data/ghes-3.16-2022-11-28/search.json @@ -2223,6 +2223,19 @@ "schema": { "type": "string" } + }, + { + "name": "search_type", + "description": "

The type of search to perform on issues. When not specified, the default is lexical search.

\n
    \n
  • semantic — performs a pure semantic (vector) search using embedding-based understanding.
    • \n
  • hybrid — combines semantic search with lexical search for best results.
    • \n
\n

Semantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (/search/issues).

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "semantic", + "hybrid" + ] + } } ], "bodyParameters": [], @@ -2230,16 +2243,17 @@ "codeExamples": [ { "request": { - "description": "Example", + "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response

", + "description": "

Hybrid search response

", "example": { "total_count": 280, "incomplete_results": false, + "search_type": "hybrid", "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", @@ -5094,16 +5108,2797 @@ } } } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" }, { - "httpStatusCode": "304", - "description": "

Not modified

" + "request": { + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Hybrid search with lexical fallback

", + "example": { + "total_count": 280, + "incomplete_results": false, + "search_type": "lexical", + "lexical_fallback_reason": [ + "quoted_text" + ], + "items": [ + "..." + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items", + "search_type" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "title": "Issue Search Result Item", + "description": "Issue Search Result Item", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "The name of the option", + "type": "string" + }, + "color": { + "description": "The color of the option", + "type": "string" + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "type": "string" + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "body": { + "type": "string" + }, + "score": { + "type": "number" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "draft": { + "type": "boolean" + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "full_name": { + "type": "string" + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "spdx_id": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean" + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean" + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean" + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "pinned_comment": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time" + }, + "pinned_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "pinned_at", + "pinned_by" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at", + "score" + ] + } + }, + "search_type": { + "type": "string", + "description": "The type of search that was performed. Possible values are `lexical`, `semantic`, or `hybrid`.", + "enum": [ + "lexical", + "semantic", + "hybrid" + ] + }, + "lexical_fallback_reason": { + "type": "array", + "description": "When a semantic or hybrid search falls back to lexical search, this field contains the reasons for the fallback. Only present when a fallback occurred.", + "items": { + "type": "string", + "enum": [ + "no_text_terms", + "quoted_text", + "non_issue_target", + "or_boolean_not_supported", + "no_accessible_repos", + "server_error", + "only_non_semantic_fields_requested" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

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

Not modified

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

Requires authentication

" }, { "httpStatusCode": "403", diff --git a/src/rest/data/ghes-3.17-2022-11-28/releases.json b/src/rest/data/ghes-3.17-2022-11-28/releases.json index 7b18d0a65e2d..977f78148159 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/releases.json +++ b/src/rest/data/ghes-3.17-2022-11-28/releases.json @@ -3427,7 +3427,7 @@ "false", "legacy" ], - "default": true + "default": "true" } ], "descriptionHTML": "

Users with push access to the repository can edit a release.

", diff --git a/src/rest/data/ghes-3.17-2022-11-28/search.json b/src/rest/data/ghes-3.17-2022-11-28/search.json index b039b7f05e10..131c44ff064b 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/search.json +++ b/src/rest/data/ghes-3.17-2022-11-28/search.json @@ -2254,6 +2254,19 @@ "schema": { "type": "string" } + }, + { + "name": "search_type", + "description": "

The type of search to perform on issues. When not specified, the default is lexical search.

\n
    \n
  • semantic — performs a pure semantic (vector) search using embedding-based understanding.
    • \n
  • hybrid — combines semantic search with lexical search for best results.
    • \n
\n

Semantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (/search/issues).

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "semantic", + "hybrid" + ] + } } ], "bodyParameters": [], @@ -2261,16 +2274,17 @@ "codeExamples": [ { "request": { - "description": "Example", + "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response

", + "description": "

Hybrid search response

", "example": { "total_count": 280, "incomplete_results": false, + "search_type": "hybrid", "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", @@ -5125,16 +5139,2797 @@ } } } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" }, { - "httpStatusCode": "304", - "description": "

Not modified

" + "request": { + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Hybrid search with lexical fallback

", + "example": { + "total_count": 280, + "incomplete_results": false, + "search_type": "lexical", + "lexical_fallback_reason": [ + "quoted_text" + ], + "items": [ + "..." + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items", + "search_type" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "title": "Issue Search Result Item", + "description": "Issue Search Result Item", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "The name of the option", + "type": "string" + }, + "color": { + "description": "The color of the option", + "type": "string" + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "type": "string" + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "body": { + "type": "string" + }, + "score": { + "type": "number" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "draft": { + "type": "boolean" + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "full_name": { + "type": "string" + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "spdx_id": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean" + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean" + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean" + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "pinned_comment": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time" + }, + "pinned_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "pinned_at", + "pinned_by" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at", + "score" + ] + } + }, + "search_type": { + "type": "string", + "description": "The type of search that was performed. Possible values are `lexical`, `semantic`, or `hybrid`.", + "enum": [ + "lexical", + "semantic", + "hybrid" + ] + }, + "lexical_fallback_reason": { + "type": "array", + "description": "When a semantic or hybrid search falls back to lexical search, this field contains the reasons for the fallback. Only present when a fallback occurred.", + "items": { + "type": "string", + "enum": [ + "no_text_terms", + "quoted_text", + "non_issue_target", + "or_boolean_not_supported", + "no_accessible_repos", + "server_error", + "only_non_semantic_fields_requested" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

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

Not modified

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

Requires authentication

" }, { "httpStatusCode": "403", diff --git a/src/rest/data/ghes-3.18-2022-11-28/credentials.json b/src/rest/data/ghes-3.18-2022-11-28/credentials.json index c74a4a9ad255..0cac1b47b9bd 100644 --- a/src/rest/data/ghes-3.18-2022-11-28/credentials.json +++ b/src/rest/data/ghes-3.18-2022-11-28/credentials.json @@ -60,11 +60,10 @@ ], "previews": [], "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] } } ] diff --git a/src/rest/data/ghes-3.18-2022-11-28/releases.json b/src/rest/data/ghes-3.18-2022-11-28/releases.json index 2b0edc3f6493..62945ce9fabe 100644 --- a/src/rest/data/ghes-3.18-2022-11-28/releases.json +++ b/src/rest/data/ghes-3.18-2022-11-28/releases.json @@ -3427,7 +3427,7 @@ "false", "legacy" ], - "default": true + "default": "true" } ], "descriptionHTML": "

Users with push access to the repository can edit a release.

", diff --git a/src/rest/data/ghes-3.18-2022-11-28/search.json b/src/rest/data/ghes-3.18-2022-11-28/search.json index 009a2e787c99..ed3d28e0e41d 100644 --- a/src/rest/data/ghes-3.18-2022-11-28/search.json +++ b/src/rest/data/ghes-3.18-2022-11-28/search.json @@ -2264,6 +2264,19 @@ "schema": { "type": "string" } + }, + { + "name": "search_type", + "description": "

The type of search to perform on issues. When not specified, the default is lexical search.

\n
    \n
  • semantic — performs a pure semantic (vector) search using embedding-based understanding.
    • \n
  • hybrid — combines semantic search with lexical search for best results.
    • \n
\n

Semantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (/search/issues).

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "semantic", + "hybrid" + ] + } } ], "bodyParameters": [], @@ -2271,16 +2284,17 @@ "codeExamples": [ { "request": { - "description": "Example", + "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response

", + "description": "

Hybrid search response

", "example": { "total_count": 280, "incomplete_results": false, + "search_type": "hybrid", "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", @@ -5135,16 +5149,2797 @@ } } } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" }, { - "httpStatusCode": "304", - "description": "

Not modified

" + "request": { + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Hybrid search with lexical fallback

", + "example": { + "total_count": 280, + "incomplete_results": false, + "search_type": "lexical", + "lexical_fallback_reason": [ + "quoted_text" + ], + "items": [ + "..." + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items", + "search_type" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "title": "Issue Search Result Item", + "description": "Issue Search Result Item", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "The name of the option", + "type": "string" + }, + "color": { + "description": "The color of the option", + "type": "string" + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "type": "string" + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "body": { + "type": "string" + }, + "score": { + "type": "number" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "draft": { + "type": "boolean" + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "full_name": { + "type": "string" + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "spdx_id": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean" + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean" + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean" + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "pinned_comment": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time" + }, + "pinned_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "pinned_at", + "pinned_by" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at", + "score" + ] + } + }, + "search_type": { + "type": "string", + "description": "The type of search that was performed. Possible values are `lexical`, `semantic`, or `hybrid`.", + "enum": [ + "lexical", + "semantic", + "hybrid" + ] + }, + "lexical_fallback_reason": { + "type": "array", + "description": "When a semantic or hybrid search falls back to lexical search, this field contains the reasons for the fallback. Only present when a fallback occurred.", + "items": { + "type": "string", + "enum": [ + "no_text_terms", + "quoted_text", + "non_issue_target", + "or_boolean_not_supported", + "no_accessible_repos", + "server_error", + "only_non_semantic_fields_requested" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

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

Not modified

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

Requires authentication

" }, { "httpStatusCode": "403", diff --git a/src/rest/data/ghes-3.19-2022-11-28/credentials.json b/src/rest/data/ghes-3.19-2022-11-28/credentials.json index c74a4a9ad255..0cac1b47b9bd 100644 --- a/src/rest/data/ghes-3.19-2022-11-28/credentials.json +++ b/src/rest/data/ghes-3.19-2022-11-28/credentials.json @@ -60,11 +60,10 @@ ], "previews": [], "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] } } ] diff --git a/src/rest/data/ghes-3.19-2022-11-28/releases.json b/src/rest/data/ghes-3.19-2022-11-28/releases.json index 5c0e34211f1f..023ebfc014a7 100644 --- a/src/rest/data/ghes-3.19-2022-11-28/releases.json +++ b/src/rest/data/ghes-3.19-2022-11-28/releases.json @@ -3427,7 +3427,7 @@ "false", "legacy" ], - "default": true + "default": "true" } ], "descriptionHTML": "

Users with push access to the repository can edit a release.

", diff --git a/src/rest/data/ghes-3.19-2022-11-28/search.json b/src/rest/data/ghes-3.19-2022-11-28/search.json index a05134fbf4ac..f6c22267e9f2 100644 --- a/src/rest/data/ghes-3.19-2022-11-28/search.json +++ b/src/rest/data/ghes-3.19-2022-11-28/search.json @@ -2264,6 +2264,19 @@ "schema": { "type": "string" } + }, + { + "name": "search_type", + "description": "

The type of search to perform on issues. When not specified, the default is lexical search.

\n
    \n
  • semantic — performs a pure semantic (vector) search using embedding-based understanding.
    • \n
  • hybrid — combines semantic search with lexical search for best results.
    • \n
\n

Semantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (/search/issues).

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "semantic", + "hybrid" + ] + } } ], "bodyParameters": [], @@ -2271,16 +2284,17 @@ "codeExamples": [ { "request": { - "description": "Example", + "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response

", + "description": "

Hybrid search response

", "example": { "total_count": 280, "incomplete_results": false, + "search_type": "hybrid", "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", @@ -5135,16 +5149,2797 @@ } } } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" }, { - "httpStatusCode": "304", - "description": "

Not modified

" + "request": { + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Hybrid search with lexical fallback

", + "example": { + "total_count": 280, + "incomplete_results": false, + "search_type": "lexical", + "lexical_fallback_reason": [ + "quoted_text" + ], + "items": [ + "..." + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items", + "search_type" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "title": "Issue Search Result Item", + "description": "Issue Search Result Item", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "The name of the option", + "type": "string" + }, + "color": { + "description": "The color of the option", + "type": "string" + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "type": "string" + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "body": { + "type": "string" + }, + "score": { + "type": "number" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "draft": { + "type": "boolean" + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "full_name": { + "type": "string" + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "spdx_id": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean" + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean" + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean" + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "pinned_comment": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time" + }, + "pinned_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "pinned_at", + "pinned_by" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at", + "score" + ] + } + }, + "search_type": { + "type": "string", + "description": "The type of search that was performed. Possible values are `lexical`, `semantic`, or `hybrid`.", + "enum": [ + "lexical", + "semantic", + "hybrid" + ] + }, + "lexical_fallback_reason": { + "type": "array", + "description": "When a semantic or hybrid search falls back to lexical search, this field contains the reasons for the fallback. Only present when a fallback occurred.", + "items": { + "type": "string", + "enum": [ + "no_text_terms", + "quoted_text", + "non_issue_target", + "or_boolean_not_supported", + "no_accessible_repos", + "server_error", + "only_non_semantic_fields_requested" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

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

Not modified

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

Requires authentication

" }, { "httpStatusCode": "403", diff --git a/src/rest/data/ghes-3.20-2022-11-28/credentials.json b/src/rest/data/ghes-3.20-2022-11-28/credentials.json index c74a4a9ad255..0cac1b47b9bd 100644 --- a/src/rest/data/ghes-3.20-2022-11-28/credentials.json +++ b/src/rest/data/ghes-3.20-2022-11-28/credentials.json @@ -60,11 +60,10 @@ ], "previews": [], "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] } } ] diff --git a/src/rest/data/ghes-3.20-2022-11-28/releases.json b/src/rest/data/ghes-3.20-2022-11-28/releases.json index b56adc9c195f..e3fa9e665bc6 100644 --- a/src/rest/data/ghes-3.20-2022-11-28/releases.json +++ b/src/rest/data/ghes-3.20-2022-11-28/releases.json @@ -3427,7 +3427,7 @@ "false", "legacy" ], - "default": true + "default": "true" } ], "descriptionHTML": "

Users with push access to the repository can edit a release.

", diff --git a/src/rest/data/ghes-3.20-2022-11-28/search.json b/src/rest/data/ghes-3.20-2022-11-28/search.json index 248cc6e27593..330d8e57c9f9 100644 --- a/src/rest/data/ghes-3.20-2022-11-28/search.json +++ b/src/rest/data/ghes-3.20-2022-11-28/search.json @@ -2264,6 +2264,19 @@ "schema": { "type": "string" } + }, + { + "name": "search_type", + "description": "

The type of search to perform on issues. When not specified, the default is lexical search.

\n
    \n
  • semantic — performs a pure semantic (vector) search using embedding-based understanding.
    • \n
  • hybrid — combines semantic search with lexical search for best results.
    • \n
\n

Semantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (/search/issues).

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "semantic", + "hybrid" + ] + } } ], "bodyParameters": [], @@ -2271,16 +2284,17 @@ "codeExamples": [ { "request": { - "description": "Example", + "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Response

", + "description": "

Hybrid search response

", "example": { "total_count": 280, "incomplete_results": false, + "search_type": "hybrid", "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", @@ -5135,16 +5149,2797 @@ } } } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" }, { - "httpStatusCode": "304", - "description": "

Not modified

" + "request": { + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Hybrid search with lexical fallback

", + "example": { + "total_count": 280, + "incomplete_results": false, + "search_type": "lexical", + "lexical_fallback_reason": [ + "quoted_text" + ], + "items": [ + "..." + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items", + "search_type" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "title": "Issue Search Result Item", + "description": "Issue Search Result Item", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "integer" + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "The name of the option", + "type": "string" + }, + "color": { + "description": "The color of the option", + "type": "string" + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "state": { + "type": "string" + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "body": { + "type": "string" + }, + "score": { + "type": "number" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "draft": { + "type": "boolean" + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "full_name": { + "type": "string" + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "spdx_id": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean" + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean" + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean" + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean" + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "pinned_comment": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "external_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time" + }, + "pinned_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "pinned_at", + "pinned_by" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at", + "score" + ] + } + }, + "search_type": { + "type": "string", + "description": "The type of search that was performed. Possible values are `lexical`, `semantic`, or `hybrid`.", + "enum": [ + "lexical", + "semantic", + "hybrid" + ] + }, + "lexical_fallback_reason": { + "type": "array", + "description": "When a semantic or hybrid search falls back to lexical search, this field contains the reasons for the fallback. Only present when a fallback occurred.", + "items": { + "type": "string", + "enum": [ + "no_text_terms", + "quoted_text", + "non_issue_target", + "or_boolean_not_supported", + "no_accessible_repos", + "server_error", + "only_non_semantic_fields_requested" + ] + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

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

Not modified

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

Requires authentication

" }, { "httpStatusCode": "403", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 32755ef876e3..aca447679538 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -55,5 +55,5 @@ ] } }, - "sha": "79f95939a0e167076fd369c97ad924f70cf65b37" + "sha": "f8524e666767de6a6784abf509992ad962dd7762" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index edcfedd0a079..3cba42ced821 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "79f95939a0e167076fd369c97ad924f70cf65b37" + "sha": "f8524e666767de6a6784abf509992ad962dd7762" } \ No newline at end of file From adda94aef80cf0b509520b61a68efc44b87578d8 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Thu, 2 Apr 2026 13:50:42 +0100 Subject: [PATCH 08/11] [2026-04-02] Copilot organization custom instructions [GA] (#60597) Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: timrogers <116134+timrogers@users.noreply.github.com> Co-authored-by: Tim Rogers Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- content/copilot/concepts/prompting/response-customization.md | 2 +- data/reusables/copilot/custom-instructions-org-support.md | 2 -- data/reusables/copilot/differences-cfi-cfb-table.md | 2 +- 3 files changed, 2 insertions(+), 4 deletions(-) diff --git a/content/copilot/concepts/prompting/response-customization.md b/content/copilot/concepts/prompting/response-customization.md index 909ec3d49129..484c893310a5 100644 --- a/content/copilot/concepts/prompting/response-customization.md +++ b/content/copilot/concepts/prompting/response-customization.md @@ -32,7 +32,7 @@ There are three main types of custom instructions that you can use to customize * **[Personal instructions](#about-personal-instructions)** apply to all conversations you have with {% data variables.copilot.copilot_chat_short %} across the {% data variables.product.github %} website. They allow you to specify your individual preferences, such as preferred language or response style, ensuring that the responses are tailored to your personal needs. * **[Repository custom instructions](#about-repository-custom-instructions)** apply to conversations within the context of a specific repository. They are useful for defining project-specific coding standards, frameworks, or tools. For example, you can specify that a repository uses TypeScript and a particular library, ensuring consistent responses for all contributors. -* **[Organization custom instructions](#about-organization-custom-instructions)** (public preview) apply to conversations within the context of an organization on the {% data variables.product.github %} website. They are ideal for enforcing organization-wide preferences, such as a common language or security guidelines. Organization custom instructions can only be set by organization owners for organizations with a {% data variables.copilot.copilot_enterprise_short %} subscription. +* **[Organization custom instructions](#about-organization-custom-instructions)** apply to conversations within the context of an organization on the {% data variables.product.github %} website. They are ideal for enforcing organization-wide preferences, such as a common language or security guidelines. Organization custom instructions can only be set by organization owners for organizations with a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} subscription. ## About personal instructions diff --git a/data/reusables/copilot/custom-instructions-org-support.md b/data/reusables/copilot/custom-instructions-org-support.md index e9a87bc82949..05f71b655372 100644 --- a/data/reusables/copilot/custom-instructions-org-support.md +++ b/data/reusables/copilot/custom-instructions-org-support.md @@ -1,4 +1,2 @@ > [!NOTE] -> This feature is currently in {% data variables.release-phases.public_preview %} and is subject to change. -> > **Support:** Organization custom instructions are currently only supported for {% data variables.copilot.copilot_chat_short %} on {% data variables.product.prodname_dotcom_the_website %}, {% data variables.copilot.copilot_code-review_short %} on {% data variables.product.prodname_dotcom_the_website %} and {% data variables.copilot.copilot_coding_agent %} on {% data variables.product.prodname_dotcom_the_website %}. diff --git a/data/reusables/copilot/differences-cfi-cfb-table.md b/data/reusables/copilot/differences-cfi-cfb-table.md index 2d9f186fa7ac..b17202870aa1 100644 --- a/data/reusables/copilot/differences-cfi-cfb-table.md +++ b/data/reusables/copilot/differences-cfi-cfb-table.md @@ -61,7 +61,7 @@ | Customization | {% data variables.copilot.copilot_free_short %} | {% data variables.copilot.copilot_student_short %} | {% data variables.copilot.copilot_pro_short %} | {% data variables.copilot.copilot_pro_plus_short %} | {% data variables.copilot.copilot_business_short %} | {% data variables.copilot.copilot_enterprise_short %} | | --- | --- | --- | --- | --- | --- | --- | | Repository and personal custom instructions | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| Organization custom instructions ({% data variables.release-phases.public_preview %}) | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| Organization custom instructions | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | | Prompt files | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | | Model Context Protocol (MCP) | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | | Block suggestions matching public code | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | From 9bfc1cb410dd2581ae34780aa5cf7ef3576bd08e Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Thu, 2 Apr 2026 06:42:22 -0700 Subject: [PATCH 09/11] Update OpenAPI Description (#60614) Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- content/rest/agent-tasks/agent-tasks.md | 12 + content/rest/agent-tasks/index.md | 11 + content/rest/index.md | 1 + src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/actions.json | 3 +- src/rest/data/fpt-2022-11-28/agent-tasks.json | 2121 +++++++++++++++++ src/rest/data/fpt-2022-11-28/dependabot.json | 45 +- src/rest/data/fpt-2022-11-28/orgs.json | 57 +- .../data/fpt-2022-11-28/secret-scanning.json | 225 ++ .../fpt-2022-11-28/security-advisories.json | 10 +- src/rest/data/fpt-2026-03-10/actions.json | 3 +- src/rest/data/fpt-2026-03-10/agent-tasks.json | 2121 +++++++++++++++++ src/rest/data/fpt-2026-03-10/dependabot.json | 45 +- src/rest/data/fpt-2026-03-10/orgs.json | 57 +- .../data/fpt-2026-03-10/secret-scanning.json | 225 ++ .../fpt-2026-03-10/security-advisories.json | 10 +- src/rest/data/ghec-2022-11-28/actions.json | 3 +- .../data/ghec-2022-11-28/agent-tasks.json | 2121 +++++++++++++++++ src/rest/data/ghec-2022-11-28/dependabot.json | 45 +- .../ghec-2022-11-28/enterprise-admin.json | 20 + src/rest/data/ghec-2022-11-28/orgs.json | 65 +- .../data/ghec-2022-11-28/secret-scanning.json | 270 +++ .../ghec-2022-11-28/security-advisories.json | 10 +- src/rest/data/ghec-2026-03-10/actions.json | 3 +- .../data/ghec-2026-03-10/agent-tasks.json | 2121 +++++++++++++++++ src/rest/data/ghec-2026-03-10/dependabot.json | 45 +- .../ghec-2026-03-10/enterprise-admin.json | 20 + src/rest/data/ghec-2026-03-10/orgs.json | 65 +- .../data/ghec-2026-03-10/secret-scanning.json | 270 +++ .../ghec-2026-03-10/security-advisories.json | 10 +- .../data/ghes-3.14-2022-11-28/actions.json | 3 +- src/rest/data/ghes-3.14-2022-11-28/orgs.json | 12 +- .../security-advisories.json | 10 +- .../data/ghes-3.15-2022-11-28/actions.json | 3 +- src/rest/data/ghes-3.15-2022-11-28/orgs.json | 12 +- .../security-advisories.json | 10 +- .../data/ghes-3.16-2022-11-28/actions.json | 3 +- .../data/ghes-3.16-2022-11-28/dependabot.json | 40 +- src/rest/data/ghes-3.16-2022-11-28/orgs.json | 12 +- .../security-advisories.json | 10 +- .../data/ghes-3.17-2022-11-28/actions.json | 3 +- .../data/ghes-3.17-2022-11-28/dependabot.json | 40 +- src/rest/data/ghes-3.17-2022-11-28/orgs.json | 12 +- .../security-advisories.json | 10 +- .../data/ghes-3.18-2022-11-28/actions.json | 3 +- .../data/ghes-3.18-2022-11-28/dependabot.json | 40 +- src/rest/data/ghes-3.18-2022-11-28/orgs.json | 12 +- .../security-advisories.json | 10 +- .../data/ghes-3.19-2022-11-28/actions.json | 3 +- .../data/ghes-3.19-2022-11-28/dependabot.json | 40 +- src/rest/data/ghes-3.19-2022-11-28/orgs.json | 12 +- .../security-advisories.json | 10 +- .../data/ghes-3.20-2022-11-28/actions.json | 3 +- .../data/ghes-3.20-2022-11-28/dependabot.json | 40 +- src/rest/data/ghes-3.20-2022-11-28/orgs.json | 12 +- .../security-advisories.json | 10 +- src/rest/lib/config.json | 2 +- src/webhooks/data/fpt/schema.json | 53 + src/webhooks/data/ghec/schema.json | 653 ++++- src/webhooks/data/ghes-3.14/schema.json | 150 +- src/webhooks/data/ghes-3.15/schema.json | 150 +- src/webhooks/data/ghes-3.16/schema.json | 300 ++- src/webhooks/data/ghes-3.17/schema.json | 600 ++++- src/webhooks/data/ghes-3.18/schema.json | 600 ++++- src/webhooks/data/ghes-3.19/schema.json | 600 ++++- src/webhooks/data/ghes-3.20/schema.json | 600 ++++- src/webhooks/lib/config.json | 2 +- 67 files changed, 13604 insertions(+), 497 deletions(-) create mode 100644 content/rest/agent-tasks/agent-tasks.md create mode 100644 content/rest/agent-tasks/index.md create mode 100644 src/rest/data/fpt-2022-11-28/agent-tasks.json create mode 100644 src/rest/data/fpt-2026-03-10/agent-tasks.json create mode 100644 src/rest/data/ghec-2022-11-28/agent-tasks.json create mode 100644 src/rest/data/ghec-2026-03-10/agent-tasks.json diff --git a/content/rest/agent-tasks/agent-tasks.md b/content/rest/agent-tasks/agent-tasks.md new file mode 100644 index 000000000000..df8bfeb4bf5b --- /dev/null +++ b/content/rest/agent-tasks/agent-tasks.md @@ -0,0 +1,12 @@ +--- +title: Agent tasks +shortTitle: Agent tasks +intro: Use the REST API to manage agent tasks in {% data variables.product.prodname_actions %}. +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + fpt: '*' + ghec: '*' +autogenerated: rest +allowTitleToDifferFromFilename: true +--- + + diff --git a/content/rest/agent-tasks/index.md b/content/rest/agent-tasks/index.md new file mode 100644 index 000000000000..26ca85b0990f --- /dev/null +++ b/content/rest/agent-tasks/index.md @@ -0,0 +1,11 @@ +--- +title: Agent tasks +autogenerated: rest +allowTitleToDifferFromFilename: true +children: + - /agent-tasks +versions: + fpt: '*' + ghec: '*' +--- + diff --git a/content/rest/index.md b/content/rest/index.md index 5c3e8f7048f2..275694de8bd8 100644 --- a/content/rest/index.md +++ b/content/rest/index.md @@ -51,6 +51,7 @@ children: - /guides - /actions - /activity + - /agent-tasks - /announcement-banners - /apps - /billing diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 4976f135f335..796207ed2715 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "f8524e666767de6a6784abf509992ad962dd7762" + "sha": "c8a7d24eac4f40d797db33e85d5aa1480b163c27" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/actions.json b/src/rest/data/fpt-2022-11-28/actions.json index b2fc1f785d39..ba8be99fbe2d 100644 --- a/src/rest/data/fpt-2022-11-28/actions.json +++ b/src/rest/data/fpt-2022-11-28/actions.json @@ -5732,8 +5732,7 @@ { "type": "array of strings", "name": "include_claim_keys", - "description": "

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

", - "isRequired": true + "description": "

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

" } ], "descriptionHTML": "

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

\n

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

", diff --git a/src/rest/data/fpt-2022-11-28/agent-tasks.json b/src/rest/data/fpt-2022-11-28/agent-tasks.json new file mode 100644 index 000000000000..955cc66e6c24 --- /dev/null +++ b/src/rest/data/fpt-2022-11-28/agent-tasks.json @@ -0,0 +1,2121 @@ +{ + "agent-tasks": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/repos/{owner}/{repo}/tasks", + "title": "List tasks for repository", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository. The name is not case sensitive.

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

The number of results per page (max 100).

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

The page number of the results to fetch.

" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "

The field to sort results by. Can be updated_at or created_at.

" + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "

The direction to sort results. Can be asc or desc.

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

Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.

" + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean" + }, + "description": "

Filter by archived status. When true, returns only archived tasks. When false, returns only non-archived tasks.

" + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "

Only show tasks updated at or after this time (ISO 8601 timestamp)

" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "

Filter tasks by creator user ID

" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Returns a list of tasks for a specific repository

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

Tasks retrieved successfully

", + "example": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Tasks retrieved successfully

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

Bad request

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

Authentication required

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

Insufficient permissions

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

Resource not found

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

Validation Failed

" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/agents/repos/{owner}/{repo}/tasks", + "title": "Create a task", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository. The name is not case sensitive.

" + } + ], + "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

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

Model identifier

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

Custom agent identifier

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

Whether to create a PR

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

Base ref for new branch/PR

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

Type of event

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

URL of the triggering event

" + }, + { + "type": "array of strings", + "name": "event_identifiers", + "description": "

Identifiers for tracking

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

Creates a new task for a repository

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "event_content": "Fix the login button on the homepage", + "create_pull_request": true, + "base_ref": "main" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Task created successfully

", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "queued", + "session_count": 1, + "artifacts": [], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + "schema": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Task created successfully

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

Problems parsing JSON

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

Authentication required

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

Insufficient permissions

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

Validation Failed

" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/repos/{owner}/{repo}/tasks/{task_id}", + "title": "Get a task by repo", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository. The name is not case sensitive.

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

The unique identifier of the task.

" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Returns a task by ID scoped to an owner/repo path

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "task_id": "TASK_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Task retrieved successfully

", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "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", + "head_ref": "copilot/fix-1", + "base_ref": "main" + } + ] + }, + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "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" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "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": { + "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" + }, + "base_ref": { + "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", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Task retrieved successfully

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

Bad request

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

Authentication required

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

Insufficient permissions

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

Resource not found

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

Validation Failed

" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/tasks", + "title": "List tasks", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "

The number of results per page (max 100).

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

The page number of the results to fetch.

" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "

The field to sort results by. Can be updated_at or created_at.

" + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "

The direction to sort results. Can be asc or desc.

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

Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.

" + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean" + }, + "description": "

Filter by archived status. When true, returns only archived tasks. When false, returns only non-archived tasks.

" + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "

Only show tasks updated at or after this time (ISO 8601 timestamp)

" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Returns a list of tasks for the authenticated user

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

Tasks retrieved successfully

", + "example": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Tasks retrieved successfully

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

Bad request

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

Authentication required

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

Insufficient permissions

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

Validation Failed

" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/tasks/{task_id}", + "title": "Get a task by ID", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "

The unique identifier of the task.

" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Returns a task by ID with its associated sessions

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

Task retrieved successfully

", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "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", + "head_ref": "copilot/fix-1", + "base_ref": "main" + } + ] + }, + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "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" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "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": { + "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" + }, + "base_ref": { + "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", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Task retrieved successfully

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

Problems parsing request

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

Authentication required

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

Insufficient permissions

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

Resource not found

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

Validation Failed

" + } + ], + "previews": [] + } + ] +} \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/dependabot.json b/src/rest/data/fpt-2022-11-28/dependabot.json index e61c5bf1d6e5..7dec45a5bc83 100644 --- a/src/rest/data/fpt-2022-11-28/dependabot.json +++ b/src/rest/data/fpt-2022-11-28/dependabot.json @@ -225,12 +225,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -662,6 +660,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -2111,12 +2110,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -2548,6 +2545,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -3998,12 +3996,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -4301,6 +4297,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -5263,12 +5260,10 @@ "score": 8.5 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-532", @@ -5419,6 +5414,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -6553,6 +6549,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } diff --git a/src/rest/data/fpt-2022-11-28/orgs.json b/src/rest/data/fpt-2022-11-28/orgs.json index 2631dd628bbc..7f76ae172915 100644 --- a/src/rest/data/fpt-2022-11-28/orgs.json +++ b/src/rest/data/fpt-2022-11-28/orgs.json @@ -5341,6 +5341,12 @@ "type": "string", "name": "github_repository", "description": "

The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.

\n

If a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.

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

If true, the endpoint will return the created or updated record in the response body.

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

Create or update deployment records for an artifact associated\nwith an organization.\nThis endpoint allows you to record information about a specific\nartifact, such as its name, digest, environments, cluster, and\ndeployment.\nThe deployment name has to be uniqe within a cluster (i.e a\ncombination of logical, physical environment and cluster) as it\nidentifies unique deployment.\nMultiple requests for the same combination of logical, physical\nenvironment, cluster and deployment name will only create one\nrecord, successive request will update the existing record.\nThis allows for a stable tracking of a deployment where the actual\ndeployed artifact can change over time.

", @@ -5458,7 +5464,10 @@ } } } - } + }, + "required": [ + "total_count" + ] } } } @@ -5589,6 +5598,12 @@ "description": "

A list of runtime risks associated with the deployment.\nSupported values are: critical-resource, internet-exposed, lateral-movement, sensitive-data

" } ] + }, + { + "type": "boolean", + "name": "return_records", + "description": "

If true, the endpoint will return the set records in the response body

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

Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.

", @@ -5711,7 +5726,10 @@ } } } - } + }, + "required": [ + "total_count" + ] } } } @@ -5817,6 +5835,12 @@ "type": "string", "name": "github_repository", "description": "

The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.

\n

If a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.

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

If true, the endpoint will return the created record in the response body.

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

Create metadata storage records for artifacts associated with an organization.\nThis endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and\nassociated with a repository owned by the organization.

", @@ -5905,7 +5929,10 @@ } } } - } + }, + "required": [ + "total_count" + ] } } } @@ -14556,6 +14583,16 @@ "name": "network_settings_ids", "description": "

A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

", "isRequired": true + }, + { + "type": "array of strings", + "name": "failover_network_settings_ids", + "description": "

A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

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

Indicates whether the failover network resource is enabled.

" } ], "descriptionHTML": "

Creates a hosted compute network configuration for an organization.

\n

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

", @@ -14841,6 +14878,16 @@ "type": "array of strings", "name": "network_settings_ids", "description": "

A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

" + }, + { + "type": "array of strings", + "name": "failover_network_settings_ids", + "description": "

A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

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

Indicates whether the failover network resource is enabled.

" } ], "descriptionHTML": "

Updates a hosted compute network configuration for an organization.

\n

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

", @@ -15140,7 +15187,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -15920,7 +15967,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "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 509c40ef10d0..15e3ae1886c8 100644 --- a/src/rest/data/fpt-2022-11-28/secret-scanning.json +++ b/src/rest/data/fpt-2022-11-28/secret-scanning.json @@ -1288,6 +1288,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -1363,6 +1368,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -1377,6 +1387,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -1391,6 +1406,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -1447,6 +1467,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -1461,6 +1486,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -1475,6 +1505,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -1489,6 +1524,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -1503,6 +1543,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ @@ -2533,6 +2578,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -2608,6 +2658,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -2622,6 +2677,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -2636,6 +2696,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -2692,6 +2757,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -2706,6 +2776,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -2720,6 +2795,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -2734,6 +2814,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -2748,6 +2833,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ @@ -3563,6 +3653,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -3638,6 +3733,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -3652,6 +3752,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -3666,6 +3771,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -3722,6 +3832,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -3736,6 +3851,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -3750,6 +3870,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -3764,6 +3889,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -3778,6 +3908,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ @@ -4662,6 +4797,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -4737,6 +4877,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -4751,6 +4896,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -4765,6 +4915,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -4821,6 +4976,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -4835,6 +4995,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -4849,6 +5014,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -4863,6 +5033,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -4877,6 +5052,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ @@ -5283,6 +5463,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -5358,6 +5543,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -5372,6 +5562,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -5386,6 +5581,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -5442,6 +5642,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -5456,6 +5661,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -5470,6 +5680,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -5484,6 +5699,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -5498,6 +5718,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ diff --git a/src/rest/data/fpt-2022-11-28/security-advisories.json b/src/rest/data/fpt-2022-11-28/security-advisories.json index f908ef9240bc..5e5a2065ce9a 100644 --- a/src/rest/data/fpt-2022-11-28/security-advisories.json +++ b/src/rest/data/fpt-2022-11-28/security-advisories.json @@ -298,12 +298,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { diff --git a/src/rest/data/fpt-2026-03-10/actions.json b/src/rest/data/fpt-2026-03-10/actions.json index a914dd54ba55..9db2ebca6a3b 100644 --- a/src/rest/data/fpt-2026-03-10/actions.json +++ b/src/rest/data/fpt-2026-03-10/actions.json @@ -5732,8 +5732,7 @@ { "type": "array of strings", "name": "include_claim_keys", - "description": "

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

", - "isRequired": true + "description": "

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

" } ], "descriptionHTML": "

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

\n

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

", diff --git a/src/rest/data/fpt-2026-03-10/agent-tasks.json b/src/rest/data/fpt-2026-03-10/agent-tasks.json new file mode 100644 index 000000000000..955cc66e6c24 --- /dev/null +++ b/src/rest/data/fpt-2026-03-10/agent-tasks.json @@ -0,0 +1,2121 @@ +{ + "agent-tasks": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/repos/{owner}/{repo}/tasks", + "title": "List tasks for repository", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository. The name is not case sensitive.

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

The number of results per page (max 100).

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

The page number of the results to fetch.

" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "

The field to sort results by. Can be updated_at or created_at.

" + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "

The direction to sort results. Can be asc or desc.

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

Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.

" + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean" + }, + "description": "

Filter by archived status. When true, returns only archived tasks. When false, returns only non-archived tasks.

" + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "

Only show tasks updated at or after this time (ISO 8601 timestamp)

" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "

Filter tasks by creator user ID

" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Returns a list of tasks for a specific repository

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

Tasks retrieved successfully

", + "example": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Tasks retrieved successfully

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

Bad request

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

Authentication required

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

Insufficient permissions

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

Resource not found

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

Validation Failed

" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/agents/repos/{owner}/{repo}/tasks", + "title": "Create a task", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository. The name is not case sensitive.

" + } + ], + "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

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

Model identifier

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

Custom agent identifier

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

Whether to create a PR

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

Base ref for new branch/PR

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

Type of event

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

URL of the triggering event

" + }, + { + "type": "array of strings", + "name": "event_identifiers", + "description": "

Identifiers for tracking

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

Creates a new task for a repository

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "event_content": "Fix the login button on the homepage", + "create_pull_request": true, + "base_ref": "main" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Task created successfully

", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "queued", + "session_count": 1, + "artifacts": [], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + "schema": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Task created successfully

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

Problems parsing JSON

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

Authentication required

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

Insufficient permissions

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

Validation Failed

" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/repos/{owner}/{repo}/tasks/{task_id}", + "title": "Get a task by repo", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository. The name is not case sensitive.

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

The unique identifier of the task.

" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Returns a task by ID scoped to an owner/repo path

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "task_id": "TASK_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Task retrieved successfully

", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "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", + "head_ref": "copilot/fix-1", + "base_ref": "main" + } + ] + }, + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "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" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "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": { + "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" + }, + "base_ref": { + "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", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Task retrieved successfully

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

Bad request

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

Authentication required

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

Insufficient permissions

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

Resource not found

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

Validation Failed

" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/tasks", + "title": "List tasks", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "

The number of results per page (max 100).

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

The page number of the results to fetch.

" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "

The field to sort results by. Can be updated_at or created_at.

" + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "

The direction to sort results. Can be asc or desc.

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

Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.

" + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean" + }, + "description": "

Filter by archived status. When true, returns only archived tasks. When false, returns only non-archived tasks.

" + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "

Only show tasks updated at or after this time (ISO 8601 timestamp)

" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Returns a list of tasks for the authenticated user

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

Tasks retrieved successfully

", + "example": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Tasks retrieved successfully

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

Bad request

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

Authentication required

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

Insufficient permissions

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

Validation Failed

" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/tasks/{task_id}", + "title": "Get a task by ID", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "

The unique identifier of the task.

" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Returns a task by ID with its associated sessions

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

Task retrieved successfully

", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "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", + "head_ref": "copilot/fix-1", + "base_ref": "main" + } + ] + }, + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "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" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "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": { + "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" + }, + "base_ref": { + "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", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Task retrieved successfully

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

Problems parsing request

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

Authentication required

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

Insufficient permissions

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

Resource not found

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

Validation Failed

" + } + ], + "previews": [] + } + ] +} \ No newline at end of file diff --git a/src/rest/data/fpt-2026-03-10/dependabot.json b/src/rest/data/fpt-2026-03-10/dependabot.json index 75cf2d9e9a74..81597fcbff73 100644 --- a/src/rest/data/fpt-2026-03-10/dependabot.json +++ b/src/rest/data/fpt-2026-03-10/dependabot.json @@ -225,12 +225,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -662,6 +660,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -2083,12 +2082,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -2520,6 +2517,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -3942,12 +3940,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -4245,6 +4241,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -5179,12 +5176,10 @@ "score": 8.5 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-532", @@ -5335,6 +5330,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -6441,6 +6437,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } diff --git a/src/rest/data/fpt-2026-03-10/orgs.json b/src/rest/data/fpt-2026-03-10/orgs.json index c84f10137f99..9a6146ea82b9 100644 --- a/src/rest/data/fpt-2026-03-10/orgs.json +++ b/src/rest/data/fpt-2026-03-10/orgs.json @@ -5327,6 +5327,12 @@ "type": "string", "name": "github_repository", "description": "

The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.

\n

If a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.

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

If true, the endpoint will return the created or updated record in the response body.

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

Create or update deployment records for an artifact associated\nwith an organization.\nThis endpoint allows you to record information about a specific\nartifact, such as its name, digest, environments, cluster, and\ndeployment.\nThe deployment name has to be uniqe within a cluster (i.e a\ncombination of logical, physical environment and cluster) as it\nidentifies unique deployment.\nMultiple requests for the same combination of logical, physical\nenvironment, cluster and deployment name will only create one\nrecord, successive request will update the existing record.\nThis allows for a stable tracking of a deployment where the actual\ndeployed artifact can change over time.

", @@ -5444,7 +5450,10 @@ } } } - } + }, + "required": [ + "total_count" + ] } } } @@ -5575,6 +5584,12 @@ "description": "

A list of runtime risks associated with the deployment.\nSupported values are: critical-resource, internet-exposed, lateral-movement, sensitive-data

" } ] + }, + { + "type": "boolean", + "name": "return_records", + "description": "

If true, the endpoint will return the set records in the response body

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

Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.

", @@ -5697,7 +5712,10 @@ } } } - } + }, + "required": [ + "total_count" + ] } } } @@ -5803,6 +5821,12 @@ "type": "string", "name": "github_repository", "description": "

The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.

\n

If a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.

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

If true, the endpoint will return the created record in the response body.

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

Create metadata storage records for artifacts associated with an organization.\nThis endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and\nassociated with a repository owned by the organization.

", @@ -5891,7 +5915,10 @@ } } } - } + }, + "required": [ + "total_count" + ] } } } @@ -14509,6 +14536,16 @@ "name": "network_settings_ids", "description": "

A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

", "isRequired": true + }, + { + "type": "array of strings", + "name": "failover_network_settings_ids", + "description": "

A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

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

Indicates whether the failover network resource is enabled.

" } ], "descriptionHTML": "

Creates a hosted compute network configuration for an organization.

\n

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

", @@ -14794,6 +14831,16 @@ "type": "array of strings", "name": "network_settings_ids", "description": "

A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

" + }, + { + "type": "array of strings", + "name": "failover_network_settings_ids", + "description": "

A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

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

Indicates whether the failover network resource is enabled.

" } ], "descriptionHTML": "

Updates a hosted compute network configuration for an organization.

\n

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

", @@ -15093,7 +15140,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -15873,7 +15920,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "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 509c40ef10d0..15e3ae1886c8 100644 --- a/src/rest/data/fpt-2026-03-10/secret-scanning.json +++ b/src/rest/data/fpt-2026-03-10/secret-scanning.json @@ -1288,6 +1288,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -1363,6 +1368,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -1377,6 +1387,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -1391,6 +1406,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -1447,6 +1467,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -1461,6 +1486,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -1475,6 +1505,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -1489,6 +1524,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -1503,6 +1543,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ @@ -2533,6 +2578,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -2608,6 +2658,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -2622,6 +2677,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -2636,6 +2696,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -2692,6 +2757,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -2706,6 +2776,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -2720,6 +2795,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -2734,6 +2814,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -2748,6 +2833,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ @@ -3563,6 +3653,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -3638,6 +3733,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -3652,6 +3752,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -3666,6 +3771,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -3722,6 +3832,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -3736,6 +3851,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -3750,6 +3870,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -3764,6 +3889,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -3778,6 +3908,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ @@ -4662,6 +4797,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -4737,6 +4877,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -4751,6 +4896,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -4765,6 +4915,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -4821,6 +4976,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -4835,6 +4995,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -4849,6 +5014,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -4863,6 +5033,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -4877,6 +5052,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ @@ -5283,6 +5463,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -5358,6 +5543,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -5372,6 +5562,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -5386,6 +5581,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -5442,6 +5642,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -5456,6 +5661,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -5470,6 +5680,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -5484,6 +5699,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -5498,6 +5718,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ diff --git a/src/rest/data/fpt-2026-03-10/security-advisories.json b/src/rest/data/fpt-2026-03-10/security-advisories.json index 02cd6705ee5e..ccfc5c9b4249 100644 --- a/src/rest/data/fpt-2026-03-10/security-advisories.json +++ b/src/rest/data/fpt-2026-03-10/security-advisories.json @@ -298,12 +298,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { diff --git a/src/rest/data/ghec-2022-11-28/actions.json b/src/rest/data/ghec-2022-11-28/actions.json index 9628d211b24e..88d36909337b 100644 --- a/src/rest/data/ghec-2022-11-28/actions.json +++ b/src/rest/data/ghec-2022-11-28/actions.json @@ -8366,8 +8366,7 @@ { "type": "array of strings", "name": "include_claim_keys", - "description": "

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

", - "isRequired": true + "description": "

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

" } ], "descriptionHTML": "

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

\n

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

", diff --git a/src/rest/data/ghec-2022-11-28/agent-tasks.json b/src/rest/data/ghec-2022-11-28/agent-tasks.json new file mode 100644 index 000000000000..955cc66e6c24 --- /dev/null +++ b/src/rest/data/ghec-2022-11-28/agent-tasks.json @@ -0,0 +1,2121 @@ +{ + "agent-tasks": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/repos/{owner}/{repo}/tasks", + "title": "List tasks for repository", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository. The name is not case sensitive.

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

The number of results per page (max 100).

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

The page number of the results to fetch.

" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "

The field to sort results by. Can be updated_at or created_at.

" + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "

The direction to sort results. Can be asc or desc.

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

Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.

" + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean" + }, + "description": "

Filter by archived status. When true, returns only archived tasks. When false, returns only non-archived tasks.

" + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "

Only show tasks updated at or after this time (ISO 8601 timestamp)

" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "

Filter tasks by creator user ID

" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Returns a list of tasks for a specific repository

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

Tasks retrieved successfully

", + "example": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Tasks retrieved successfully

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

Bad request

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

Authentication required

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

Insufficient permissions

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

Resource not found

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

Validation Failed

" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/agents/repos/{owner}/{repo}/tasks", + "title": "Create a task", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository. The name is not case sensitive.

" + } + ], + "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

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

Model identifier

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

Custom agent identifier

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

Whether to create a PR

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

Base ref for new branch/PR

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

Type of event

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

URL of the triggering event

" + }, + { + "type": "array of strings", + "name": "event_identifiers", + "description": "

Identifiers for tracking

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

Creates a new task for a repository

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "event_content": "Fix the login button on the homepage", + "create_pull_request": true, + "base_ref": "main" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Task created successfully

", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "queued", + "session_count": 1, + "artifacts": [], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + "schema": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Task created successfully

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

Problems parsing JSON

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

Authentication required

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

Insufficient permissions

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

Validation Failed

" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/repos/{owner}/{repo}/tasks/{task_id}", + "title": "Get a task by repo", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository. The name is not case sensitive.

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

The unique identifier of the task.

" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Returns a task by ID scoped to an owner/repo path

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "task_id": "TASK_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Task retrieved successfully

", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "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", + "head_ref": "copilot/fix-1", + "base_ref": "main" + } + ] + }, + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "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" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "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": { + "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" + }, + "base_ref": { + "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", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Task retrieved successfully

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

Bad request

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

Authentication required

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

Insufficient permissions

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

Resource not found

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

Validation Failed

" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/tasks", + "title": "List tasks", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "

The number of results per page (max 100).

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

The page number of the results to fetch.

" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "

The field to sort results by. Can be updated_at or created_at.

" + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "

The direction to sort results. Can be asc or desc.

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

Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.

" + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean" + }, + "description": "

Filter by archived status. When true, returns only archived tasks. When false, returns only non-archived tasks.

" + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "

Only show tasks updated at or after this time (ISO 8601 timestamp)

" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Returns a list of tasks for the authenticated user

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

Tasks retrieved successfully

", + "example": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Tasks retrieved successfully

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

Bad request

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

Authentication required

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

Insufficient permissions

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

Validation Failed

" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/tasks/{task_id}", + "title": "Get a task by ID", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "

The unique identifier of the task.

" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Returns a task by ID with its associated sessions

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

Task retrieved successfully

", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "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", + "head_ref": "copilot/fix-1", + "base_ref": "main" + } + ] + }, + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "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" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "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": { + "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" + }, + "base_ref": { + "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", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Task retrieved successfully

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

Problems parsing request

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

Authentication required

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

Insufficient permissions

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

Resource not found

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

Validation Failed

" + } + ], + "previews": [] + } + ] +} \ No newline at end of file diff --git a/src/rest/data/ghec-2022-11-28/dependabot.json b/src/rest/data/ghec-2022-11-28/dependabot.json index 9d1521634032..50c9eb27d401 100644 --- a/src/rest/data/ghec-2022-11-28/dependabot.json +++ b/src/rest/data/ghec-2022-11-28/dependabot.json @@ -1931,12 +1931,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -2368,6 +2366,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -3817,12 +3816,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -4254,6 +4251,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -5704,12 +5702,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -6007,6 +6003,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -6969,12 +6966,10 @@ "score": 8.5 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-532", @@ -7125,6 +7120,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -8259,6 +8255,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } diff --git a/src/rest/data/ghec-2022-11-28/enterprise-admin.json b/src/rest/data/ghec-2022-11-28/enterprise-admin.json index 6c24fc9f643c..0fb465ee444f 100644 --- a/src/rest/data/ghec-2022-11-28/enterprise-admin.json +++ b/src/rest/data/ghec-2022-11-28/enterprise-admin.json @@ -7650,6 +7650,16 @@ "name": "network_settings_ids", "description": "

A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

", "isRequired": true + }, + { + "type": "array of strings", + "name": "failover_network_settings_ids", + "description": "

A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

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

Indicates whether the failover network resource is enabled.

" } ], "descriptionHTML": "

Creates a hosted compute network configuration for an enterprise.

", @@ -7927,6 +7937,16 @@ "type": "array of strings", "name": "network_settings_ids", "description": "

A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

" + }, + { + "type": "array of strings", + "name": "failover_network_settings_ids", + "description": "

A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

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

Indicates whether the failover network resource is enabled.

" } ], "descriptionHTML": "

Updates a hosted compute network configuration for an enterprise.

", diff --git a/src/rest/data/ghec-2022-11-28/orgs.json b/src/rest/data/ghec-2022-11-28/orgs.json index 14cde9a61a3c..d8393f64ceda 100644 --- a/src/rest/data/ghec-2022-11-28/orgs.json +++ b/src/rest/data/ghec-2022-11-28/orgs.json @@ -5963,6 +5963,12 @@ "type": "string", "name": "github_repository", "description": "

The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.

\n

If a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.

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

If true, the endpoint will return the created or updated record in the response body.

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

Create or update deployment records for an artifact associated\nwith an organization.\nThis endpoint allows you to record information about a specific\nartifact, such as its name, digest, environments, cluster, and\ndeployment.\nThe deployment name has to be uniqe within a cluster (i.e a\ncombination of logical, physical environment and cluster) as it\nidentifies unique deployment.\nMultiple requests for the same combination of logical, physical\nenvironment, cluster and deployment name will only create one\nrecord, successive request will update the existing record.\nThis allows for a stable tracking of a deployment where the actual\ndeployed artifact can change over time.

", @@ -6080,7 +6086,10 @@ } } } - } + }, + "required": [ + "total_count" + ] } } } @@ -6211,6 +6220,12 @@ "description": "

A list of runtime risks associated with the deployment.\nSupported values are: critical-resource, internet-exposed, lateral-movement, sensitive-data

" } ] + }, + { + "type": "boolean", + "name": "return_records", + "description": "

If true, the endpoint will return the set records in the response body

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

Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.

", @@ -6333,7 +6348,10 @@ } } } - } + }, + "required": [ + "total_count" + ] } } } @@ -6439,6 +6457,12 @@ "type": "string", "name": "github_repository", "description": "

The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.

\n

If a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.

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

If true, the endpoint will return the created record in the response body.

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

Create metadata storage records for artifacts associated with an organization.\nThis endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and\nassociated with a repository owned by the organization.

", @@ -6527,7 +6551,10 @@ } } } - } + }, + "required": [ + "total_count" + ] } } } @@ -18424,6 +18451,16 @@ "name": "network_settings_ids", "description": "

A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

", "isRequired": true + }, + { + "type": "array of strings", + "name": "failover_network_settings_ids", + "description": "

A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

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

Indicates whether the failover network resource is enabled.

" } ], "descriptionHTML": "

Creates a hosted compute network configuration for an organization.

\n

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

", @@ -18709,6 +18746,16 @@ "type": "array of strings", "name": "network_settings_ids", "description": "

A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

" + }, + { + "type": "array of strings", + "name": "failover_network_settings_ids", + "description": "

A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

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

Indicates whether the failover network resource is enabled.

" } ], "descriptionHTML": "

Updates a hosted compute network configuration for an organization.

\n

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

", @@ -19008,7 +19055,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -19100,7 +19147,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -19467,7 +19514,7 @@ ] } ], - "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -20208,7 +20255,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -20530,7 +20577,7 @@ ] } ], - "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -20831,7 +20878,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "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 2de9768edec4..b23769f571b8 100644 --- a/src/rest/data/ghec-2022-11-28/secret-scanning.json +++ b/src/rest/data/ghec-2022-11-28/secret-scanning.json @@ -1279,6 +1279,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -1354,6 +1359,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -1368,6 +1378,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -1382,6 +1397,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -1438,6 +1458,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -1452,6 +1477,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -1466,6 +1496,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -1480,6 +1515,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -1494,6 +1534,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ @@ -2942,6 +2987,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -3017,6 +3067,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -3031,6 +3086,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -3045,6 +3105,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -3101,6 +3166,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -3115,6 +3185,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -3129,6 +3204,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -3143,6 +3223,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -3157,6 +3242,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ @@ -4187,6 +4277,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -4262,6 +4357,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -4276,6 +4376,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -4290,6 +4395,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -4346,6 +4456,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -4360,6 +4475,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -4374,6 +4494,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -4388,6 +4513,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -4402,6 +4532,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ @@ -5217,6 +5352,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -5292,6 +5432,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -5306,6 +5451,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -5320,6 +5470,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -5376,6 +5531,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -5390,6 +5550,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -5404,6 +5569,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -5418,6 +5588,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -5432,6 +5607,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ @@ -6316,6 +6496,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -6391,6 +6576,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -6405,6 +6595,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -6419,6 +6614,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -6475,6 +6675,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -6489,6 +6694,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -6503,6 +6713,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -6517,6 +6732,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -6531,6 +6751,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ @@ -6937,6 +7162,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -7012,6 +7242,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -7026,6 +7261,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -7040,6 +7280,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -7096,6 +7341,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -7110,6 +7360,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -7124,6 +7379,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -7138,6 +7398,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -7152,6 +7417,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ diff --git a/src/rest/data/ghec-2022-11-28/security-advisories.json b/src/rest/data/ghec-2022-11-28/security-advisories.json index a1bb36489b39..67d8b1140337 100644 --- a/src/rest/data/ghec-2022-11-28/security-advisories.json +++ b/src/rest/data/ghec-2022-11-28/security-advisories.json @@ -298,12 +298,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { diff --git a/src/rest/data/ghec-2026-03-10/actions.json b/src/rest/data/ghec-2026-03-10/actions.json index 4be59941e959..ef506710c885 100644 --- a/src/rest/data/ghec-2026-03-10/actions.json +++ b/src/rest/data/ghec-2026-03-10/actions.json @@ -8366,8 +8366,7 @@ { "type": "array of strings", "name": "include_claim_keys", - "description": "

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

", - "isRequired": true + "description": "

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

" } ], "descriptionHTML": "

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

\n

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

", diff --git a/src/rest/data/ghec-2026-03-10/agent-tasks.json b/src/rest/data/ghec-2026-03-10/agent-tasks.json new file mode 100644 index 000000000000..955cc66e6c24 --- /dev/null +++ b/src/rest/data/ghec-2026-03-10/agent-tasks.json @@ -0,0 +1,2121 @@ +{ + "agent-tasks": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/repos/{owner}/{repo}/tasks", + "title": "List tasks for repository", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository. The name is not case sensitive.

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

The number of results per page (max 100).

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

The page number of the results to fetch.

" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "

The field to sort results by. Can be updated_at or created_at.

" + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "

The direction to sort results. Can be asc or desc.

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

Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.

" + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean" + }, + "description": "

Filter by archived status. When true, returns only archived tasks. When false, returns only non-archived tasks.

" + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "

Only show tasks updated at or after this time (ISO 8601 timestamp)

" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "

Filter tasks by creator user ID

" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Returns a list of tasks for a specific repository

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

Tasks retrieved successfully

", + "example": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Tasks retrieved successfully

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

Bad request

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

Authentication required

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

Insufficient permissions

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

Resource not found

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

Validation Failed

" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/agents/repos/{owner}/{repo}/tasks", + "title": "Create a task", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository. The name is not case sensitive.

" + } + ], + "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

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

Model identifier

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

Custom agent identifier

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

Whether to create a PR

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

Base ref for new branch/PR

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

Type of event

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

URL of the triggering event

" + }, + { + "type": "array of strings", + "name": "event_identifiers", + "description": "

Identifiers for tracking

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

Creates a new task for a repository

", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "event_content": "Fix the login button on the homepage", + "create_pull_request": true, + "base_ref": "main" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Task created successfully

", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "queued", + "session_count": 1, + "artifacts": [], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + "schema": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Task created successfully

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

Problems parsing JSON

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

Authentication required

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

Insufficient permissions

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

Validation Failed

" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/repos/{owner}/{repo}/tasks/{task_id}", + "title": "Get a task by repo", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository. The name is not case sensitive.

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

The unique identifier of the task.

" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Returns a task by ID scoped to an owner/repo path

", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "task_id": "TASK_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Task retrieved successfully

", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "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", + "head_ref": "copilot/fix-1", + "base_ref": "main" + } + ] + }, + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "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" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "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": { + "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" + }, + "base_ref": { + "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", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Task retrieved successfully

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

Bad request

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

Authentication required

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

Insufficient permissions

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

Resource not found

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

Validation Failed

" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/tasks", + "title": "List tasks", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "

The number of results per page (max 100).

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

The page number of the results to fetch.

" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "

The field to sort results by. Can be updated_at or created_at.

" + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "

The direction to sort results. Can be asc or desc.

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

Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.

" + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean" + }, + "description": "

Filter by archived status. When true, returns only archived tasks. When false, returns only non-archived tasks.

" + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "

Only show tasks updated at or after this time (ISO 8601 timestamp)

" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Returns a list of tasks for the authenticated user

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

Tasks retrieved successfully

", + "example": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Tasks retrieved successfully

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

Bad request

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

Authentication required

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

Insufficient permissions

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

Validation Failed

" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/tasks/{task_id}", + "title": "Get a task by ID", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "

The unique identifier of the task.

" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Returns a task by ID with its associated sessions

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

Task retrieved successfully

", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "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", + "head_ref": "copilot/fix-1", + "base_ref": "main" + } + ] + }, + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "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" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "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" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "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": { + "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" + }, + "base_ref": { + "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", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Task retrieved successfully

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

Problems parsing request

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

Authentication required

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

Insufficient permissions

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

Resource not found

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

Validation Failed

" + } + ], + "previews": [] + } + ] +} \ No newline at end of file diff --git a/src/rest/data/ghec-2026-03-10/dependabot.json b/src/rest/data/ghec-2026-03-10/dependabot.json index 831b2f31c020..a3e1d3cbd03e 100644 --- a/src/rest/data/ghec-2026-03-10/dependabot.json +++ b/src/rest/data/ghec-2026-03-10/dependabot.json @@ -1931,12 +1931,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -2368,6 +2366,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -3789,12 +3788,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -4226,6 +4223,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -5648,12 +5646,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -5951,6 +5947,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -6885,12 +6882,10 @@ "score": 8.5 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-532", @@ -7041,6 +7036,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -8147,6 +8143,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } diff --git a/src/rest/data/ghec-2026-03-10/enterprise-admin.json b/src/rest/data/ghec-2026-03-10/enterprise-admin.json index 6c24fc9f643c..0fb465ee444f 100644 --- a/src/rest/data/ghec-2026-03-10/enterprise-admin.json +++ b/src/rest/data/ghec-2026-03-10/enterprise-admin.json @@ -7650,6 +7650,16 @@ "name": "network_settings_ids", "description": "

A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

", "isRequired": true + }, + { + "type": "array of strings", + "name": "failover_network_settings_ids", + "description": "

A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

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

Indicates whether the failover network resource is enabled.

" } ], "descriptionHTML": "

Creates a hosted compute network configuration for an enterprise.

", @@ -7927,6 +7937,16 @@ "type": "array of strings", "name": "network_settings_ids", "description": "

A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

" + }, + { + "type": "array of strings", + "name": "failover_network_settings_ids", + "description": "

A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

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

Indicates whether the failover network resource is enabled.

" } ], "descriptionHTML": "

Updates a hosted compute network configuration for an enterprise.

", diff --git a/src/rest/data/ghec-2026-03-10/orgs.json b/src/rest/data/ghec-2026-03-10/orgs.json index b59a9074f606..47eb0c55d305 100644 --- a/src/rest/data/ghec-2026-03-10/orgs.json +++ b/src/rest/data/ghec-2026-03-10/orgs.json @@ -5949,6 +5949,12 @@ "type": "string", "name": "github_repository", "description": "

The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.

\n

If a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.

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

If true, the endpoint will return the created or updated record in the response body.

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

Create or update deployment records for an artifact associated\nwith an organization.\nThis endpoint allows you to record information about a specific\nartifact, such as its name, digest, environments, cluster, and\ndeployment.\nThe deployment name has to be uniqe within a cluster (i.e a\ncombination of logical, physical environment and cluster) as it\nidentifies unique deployment.\nMultiple requests for the same combination of logical, physical\nenvironment, cluster and deployment name will only create one\nrecord, successive request will update the existing record.\nThis allows for a stable tracking of a deployment where the actual\ndeployed artifact can change over time.

", @@ -6066,7 +6072,10 @@ } } } - } + }, + "required": [ + "total_count" + ] } } } @@ -6197,6 +6206,12 @@ "description": "

A list of runtime risks associated with the deployment.\nSupported values are: critical-resource, internet-exposed, lateral-movement, sensitive-data

" } ] + }, + { + "type": "boolean", + "name": "return_records", + "description": "

If true, the endpoint will return the set records in the response body

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

Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.

", @@ -6319,7 +6334,10 @@ } } } - } + }, + "required": [ + "total_count" + ] } } } @@ -6425,6 +6443,12 @@ "type": "string", "name": "github_repository", "description": "

The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.

\n

If a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.

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

If true, the endpoint will return the created record in the response body.

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

Create metadata storage records for artifacts associated with an organization.\nThis endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and\nassociated with a repository owned by the organization.

", @@ -6513,7 +6537,10 @@ } } } - } + }, + "required": [ + "total_count" + ] } } } @@ -18158,6 +18185,16 @@ "name": "network_settings_ids", "description": "

A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

", "isRequired": true + }, + { + "type": "array of strings", + "name": "failover_network_settings_ids", + "description": "

A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

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

Indicates whether the failover network resource is enabled.

" } ], "descriptionHTML": "

Creates a hosted compute network configuration for an organization.

\n

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

", @@ -18443,6 +18480,16 @@ "type": "array of strings", "name": "network_settings_ids", "description": "

A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

" + }, + { + "type": "array of strings", + "name": "failover_network_settings_ids", + "description": "

A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

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

Indicates whether the failover network resource is enabled.

" } ], "descriptionHTML": "

Updates a hosted compute network configuration for an organization.

\n

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

", @@ -18742,7 +18789,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -18834,7 +18881,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -19201,7 +19248,7 @@ ] } ], - "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -19942,7 +19989,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -20264,7 +20311,7 @@ ] } ], - "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -20565,7 +20612,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "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 2de9768edec4..b23769f571b8 100644 --- a/src/rest/data/ghec-2026-03-10/secret-scanning.json +++ b/src/rest/data/ghec-2026-03-10/secret-scanning.json @@ -1279,6 +1279,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -1354,6 +1359,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -1368,6 +1378,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -1382,6 +1397,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -1438,6 +1458,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -1452,6 +1477,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -1466,6 +1496,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -1480,6 +1515,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -1494,6 +1534,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ @@ -2942,6 +2987,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -3017,6 +3067,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -3031,6 +3086,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -3045,6 +3105,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -3101,6 +3166,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -3115,6 +3185,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -3129,6 +3204,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -3143,6 +3223,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -3157,6 +3242,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ @@ -4187,6 +4277,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -4262,6 +4357,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -4276,6 +4376,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -4290,6 +4395,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -4346,6 +4456,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -4360,6 +4475,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -4374,6 +4494,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -4388,6 +4513,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -4402,6 +4532,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ @@ -5217,6 +5352,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -5292,6 +5432,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -5306,6 +5451,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -5320,6 +5470,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -5376,6 +5531,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -5390,6 +5550,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -5404,6 +5569,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -5418,6 +5588,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -5432,6 +5607,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ @@ -6316,6 +6496,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -6391,6 +6576,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -6405,6 +6595,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -6419,6 +6614,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -6475,6 +6675,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -6489,6 +6694,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -6503,6 +6713,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -6517,6 +6732,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -6531,6 +6751,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ @@ -6937,6 +7162,11 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource." } }, "required": [ @@ -7012,6 +7242,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -7026,6 +7261,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected." } }, "required": [ @@ -7040,6 +7280,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the issue comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected." } }, "required": [ @@ -7096,6 +7341,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -7110,6 +7360,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected." } }, "required": [ @@ -7124,6 +7379,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected." } }, "required": [ @@ -7138,6 +7398,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected." } }, "required": [ @@ -7152,6 +7417,11 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected." } }, "required": [ diff --git a/src/rest/data/ghec-2026-03-10/security-advisories.json b/src/rest/data/ghec-2026-03-10/security-advisories.json index 6af69760c9e2..03989be0dfb3 100644 --- a/src/rest/data/ghec-2026-03-10/security-advisories.json +++ b/src/rest/data/ghec-2026-03-10/security-advisories.json @@ -298,12 +298,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { diff --git a/src/rest/data/ghes-3.14-2022-11-28/actions.json b/src/rest/data/ghes-3.14-2022-11-28/actions.json index 0b882c3b5aa7..fc71615f4b80 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/actions.json +++ b/src/rest/data/ghes-3.14-2022-11-28/actions.json @@ -2020,8 +2020,7 @@ { "type": "array of strings", "name": "include_claim_keys", - "description": "

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

", - "isRequired": true + "description": "

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

" } ], "descriptionHTML": "

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

\n

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

", diff --git a/src/rest/data/ghes-3.14-2022-11-28/orgs.json b/src/rest/data/ghes-3.14-2022-11-28/orgs.json index 8b4f081c66d1..bd285ea83e09 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/orgs.json +++ b/src/rest/data/ghes-3.14-2022-11-28/orgs.json @@ -8631,7 +8631,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -8723,7 +8723,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

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

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -9819,7 +9819,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -10128,7 +10128,7 @@ "description": "

A list of additional permissions included in this role.

" } ], - "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -10429,7 +10429,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghes-3.14-2022-11-28/security-advisories.json b/src/rest/data/ghes-3.14-2022-11-28/security-advisories.json index 30c6f374af32..5291574e6bce 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/security-advisories.json +++ b/src/rest/data/ghes-3.14-2022-11-28/security-advisories.json @@ -298,12 +298,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { diff --git a/src/rest/data/ghes-3.15-2022-11-28/actions.json b/src/rest/data/ghes-3.15-2022-11-28/actions.json index 0a7fe228f9b2..da2482025b1c 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/actions.json +++ b/src/rest/data/ghes-3.15-2022-11-28/actions.json @@ -2020,8 +2020,7 @@ { "type": "array of strings", "name": "include_claim_keys", - "description": "

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

", - "isRequired": true + "description": "

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

" } ], "descriptionHTML": "

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

\n

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

", diff --git a/src/rest/data/ghes-3.15-2022-11-28/orgs.json b/src/rest/data/ghes-3.15-2022-11-28/orgs.json index 445910bb2e9e..012a589ded83 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/orgs.json +++ b/src/rest/data/ghes-3.15-2022-11-28/orgs.json @@ -8639,7 +8639,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -8731,7 +8731,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -9098,7 +9098,7 @@ ] } ], - "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -9839,7 +9839,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -10161,7 +10161,7 @@ ] } ], - "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -10462,7 +10462,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghes-3.15-2022-11-28/security-advisories.json b/src/rest/data/ghes-3.15-2022-11-28/security-advisories.json index 256922e1799f..c17a7fb272d0 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/security-advisories.json +++ b/src/rest/data/ghes-3.15-2022-11-28/security-advisories.json @@ -298,12 +298,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { diff --git a/src/rest/data/ghes-3.16-2022-11-28/actions.json b/src/rest/data/ghes-3.16-2022-11-28/actions.json index 54a41696fdb8..525b26282ac5 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/actions.json +++ b/src/rest/data/ghes-3.16-2022-11-28/actions.json @@ -2020,8 +2020,7 @@ { "type": "array of strings", "name": "include_claim_keys", - "description": "

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

", - "isRequired": true + "description": "

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

" } ], "descriptionHTML": "

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

\n

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

", diff --git a/src/rest/data/ghes-3.16-2022-11-28/dependabot.json b/src/rest/data/ghes-3.16-2022-11-28/dependabot.json index 4f06dc3cc489..7d2466cc1bbe 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/dependabot.json +++ b/src/rest/data/ghes-3.16-2022-11-28/dependabot.json @@ -240,12 +240,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -1988,12 +1986,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -3746,12 +3742,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -4858,12 +4852,10 @@ "score": 8.5 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-532", diff --git a/src/rest/data/ghes-3.16-2022-11-28/orgs.json b/src/rest/data/ghes-3.16-2022-11-28/orgs.json index 2ffa8ec69085..44fa86542d7e 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/orgs.json +++ b/src/rest/data/ghes-3.16-2022-11-28/orgs.json @@ -8662,7 +8662,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -8754,7 +8754,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -9121,7 +9121,7 @@ ] } ], - "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -9862,7 +9862,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -10184,7 +10184,7 @@ ] } ], - "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -10485,7 +10485,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghes-3.16-2022-11-28/security-advisories.json b/src/rest/data/ghes-3.16-2022-11-28/security-advisories.json index d138f1875531..bfc3c733331d 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/security-advisories.json +++ b/src/rest/data/ghes-3.16-2022-11-28/security-advisories.json @@ -298,12 +298,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { diff --git a/src/rest/data/ghes-3.17-2022-11-28/actions.json b/src/rest/data/ghes-3.17-2022-11-28/actions.json index 07ae51339f10..08c47567fef2 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/actions.json +++ b/src/rest/data/ghes-3.17-2022-11-28/actions.json @@ -2020,8 +2020,7 @@ { "type": "array of strings", "name": "include_claim_keys", - "description": "

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

", - "isRequired": true + "description": "

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

" } ], "descriptionHTML": "

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

\n

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

", diff --git a/src/rest/data/ghes-3.17-2022-11-28/dependabot.json b/src/rest/data/ghes-3.17-2022-11-28/dependabot.json index f1dff5371829..92e4e478ff70 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/dependabot.json +++ b/src/rest/data/ghes-3.17-2022-11-28/dependabot.json @@ -240,12 +240,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -1988,12 +1986,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -3746,12 +3742,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -4858,12 +4852,10 @@ "score": 8.5 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-532", diff --git a/src/rest/data/ghes-3.17-2022-11-28/orgs.json b/src/rest/data/ghes-3.17-2022-11-28/orgs.json index 6e4e486430b0..f56977e495b8 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/orgs.json +++ b/src/rest/data/ghes-3.17-2022-11-28/orgs.json @@ -9097,7 +9097,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -9189,7 +9189,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -9556,7 +9556,7 @@ ] } ], - "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -10297,7 +10297,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -10619,7 +10619,7 @@ ] } ], - "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -10920,7 +10920,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghes-3.17-2022-11-28/security-advisories.json b/src/rest/data/ghes-3.17-2022-11-28/security-advisories.json index c15a78cffe80..f29b95fa4fd5 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/security-advisories.json +++ b/src/rest/data/ghes-3.17-2022-11-28/security-advisories.json @@ -298,12 +298,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { diff --git a/src/rest/data/ghes-3.18-2022-11-28/actions.json b/src/rest/data/ghes-3.18-2022-11-28/actions.json index 68b92d9a77ef..fdda87e8e3a3 100644 --- a/src/rest/data/ghes-3.18-2022-11-28/actions.json +++ b/src/rest/data/ghes-3.18-2022-11-28/actions.json @@ -2020,8 +2020,7 @@ { "type": "array of strings", "name": "include_claim_keys", - "description": "

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

", - "isRequired": true + "description": "

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

" } ], "descriptionHTML": "

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

\n

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

", diff --git a/src/rest/data/ghes-3.18-2022-11-28/dependabot.json b/src/rest/data/ghes-3.18-2022-11-28/dependabot.json index 8b117606e810..77702381f82f 100644 --- a/src/rest/data/ghes-3.18-2022-11-28/dependabot.json +++ b/src/rest/data/ghes-3.18-2022-11-28/dependabot.json @@ -240,12 +240,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -1988,12 +1986,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -3746,12 +3742,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -4858,12 +4852,10 @@ "score": 8.5 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-532", diff --git a/src/rest/data/ghes-3.18-2022-11-28/orgs.json b/src/rest/data/ghes-3.18-2022-11-28/orgs.json index d7ca0cfe5d79..f0cd3a2c3eca 100644 --- a/src/rest/data/ghes-3.18-2022-11-28/orgs.json +++ b/src/rest/data/ghes-3.18-2022-11-28/orgs.json @@ -9097,7 +9097,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -9189,7 +9189,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -9556,7 +9556,7 @@ ] } ], - "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -10297,7 +10297,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -10619,7 +10619,7 @@ ] } ], - "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -10920,7 +10920,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghes-3.18-2022-11-28/security-advisories.json b/src/rest/data/ghes-3.18-2022-11-28/security-advisories.json index b6027ec753e2..74663be124a2 100644 --- a/src/rest/data/ghes-3.18-2022-11-28/security-advisories.json +++ b/src/rest/data/ghes-3.18-2022-11-28/security-advisories.json @@ -298,12 +298,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { diff --git a/src/rest/data/ghes-3.19-2022-11-28/actions.json b/src/rest/data/ghes-3.19-2022-11-28/actions.json index 755da2bf71d4..c842c4ca1e23 100644 --- a/src/rest/data/ghes-3.19-2022-11-28/actions.json +++ b/src/rest/data/ghes-3.19-2022-11-28/actions.json @@ -2020,8 +2020,7 @@ { "type": "array of strings", "name": "include_claim_keys", - "description": "

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

", - "isRequired": true + "description": "

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

" } ], "descriptionHTML": "

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

\n

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

", diff --git a/src/rest/data/ghes-3.19-2022-11-28/dependabot.json b/src/rest/data/ghes-3.19-2022-11-28/dependabot.json index fbed907db738..f639eff618ad 100644 --- a/src/rest/data/ghes-3.19-2022-11-28/dependabot.json +++ b/src/rest/data/ghes-3.19-2022-11-28/dependabot.json @@ -1525,12 +1525,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -3273,12 +3271,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -5031,12 +5027,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -6143,12 +6137,10 @@ "score": 8.5 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-532", diff --git a/src/rest/data/ghes-3.19-2022-11-28/orgs.json b/src/rest/data/ghes-3.19-2022-11-28/orgs.json index 4cd6ea49ab54..31062ff2c169 100644 --- a/src/rest/data/ghes-3.19-2022-11-28/orgs.json +++ b/src/rest/data/ghes-3.19-2022-11-28/orgs.json @@ -9113,7 +9113,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -9205,7 +9205,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -9572,7 +9572,7 @@ ] } ], - "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -10313,7 +10313,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -10635,7 +10635,7 @@ ] } ], - "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -10936,7 +10936,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghes-3.19-2022-11-28/security-advisories.json b/src/rest/data/ghes-3.19-2022-11-28/security-advisories.json index 9387e0e14eb1..2af77805006c 100644 --- a/src/rest/data/ghes-3.19-2022-11-28/security-advisories.json +++ b/src/rest/data/ghes-3.19-2022-11-28/security-advisories.json @@ -298,12 +298,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { diff --git a/src/rest/data/ghes-3.20-2022-11-28/actions.json b/src/rest/data/ghes-3.20-2022-11-28/actions.json index 962629a57795..b1a1bc857131 100644 --- a/src/rest/data/ghes-3.20-2022-11-28/actions.json +++ b/src/rest/data/ghes-3.20-2022-11-28/actions.json @@ -2020,8 +2020,7 @@ { "type": "array of strings", "name": "include_claim_keys", - "description": "

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

", - "isRequired": true + "description": "

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

" } ], "descriptionHTML": "

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

\n

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

", diff --git a/src/rest/data/ghes-3.20-2022-11-28/dependabot.json b/src/rest/data/ghes-3.20-2022-11-28/dependabot.json index ade641eb6e70..fa42df4b6b8f 100644 --- a/src/rest/data/ghes-3.20-2022-11-28/dependabot.json +++ b/src/rest/data/ghes-3.20-2022-11-28/dependabot.json @@ -1923,12 +1923,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -3648,12 +3646,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -5374,12 +5370,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -6486,12 +6480,10 @@ "score": 8.5 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-532", diff --git a/src/rest/data/ghes-3.20-2022-11-28/orgs.json b/src/rest/data/ghes-3.20-2022-11-28/orgs.json index a0cbb53cefb6..9b58758d5058 100644 --- a/src/rest/data/ghes-3.20-2022-11-28/orgs.json +++ b/src/rest/data/ghes-3.20-2022-11-28/orgs.json @@ -10307,7 +10307,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -10399,7 +10399,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -10766,7 +10766,7 @@ ] } ], - "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -11507,7 +11507,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -11829,7 +11829,7 @@ ] } ], - "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { @@ -12130,7 +12130,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permissions of write_organization_custom_org_role in the organization.
    • \n
\n

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

", + "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

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

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghes-3.20-2022-11-28/security-advisories.json b/src/rest/data/ghes-3.20-2022-11-28/security-advisories.json index bd8c5dd3cf38..f82660c2469e 100644 --- a/src/rest/data/ghes-3.20-2022-11-28/security-advisories.json +++ b/src/rest/data/ghes-3.20-2022-11-28/security-advisories.json @@ -298,12 +298,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index aca447679538..af7b303a6fe1 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -55,5 +55,5 @@ ] } }, - "sha": "f8524e666767de6a6784abf509992ad962dd7762" + "sha": "c8a7d24eac4f40d797db33e85d5aa1480b163c27" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 0d99ffa1bc03..96a06efd0053 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -16964,6 +16964,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -17802,6 +17803,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -18640,6 +18642,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -19478,6 +19481,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -20316,6 +20320,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -21154,6 +21159,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -21992,6 +21998,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -22830,6 +22837,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -265919,6 +265927,11 @@ "name": "commit_url", "description": "

The API URL to get the associated commit resource

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

The GitHub URL to get the associated commit resource.

" } ] }, @@ -265993,6 +266006,11 @@ "name": "issue_title_url", "description": "

The API URL to get the issue where the secret was detected.

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

The GitHub URL for the issue where the secret was detected.

" } ] }, @@ -266006,6 +266024,11 @@ "name": "issue_body_url", "description": "

The API URL to get the issue where the secret was detected.

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

The GitHub URL for the issue where the secret was detected.

" } ] }, @@ -266019,6 +266042,11 @@ "name": "issue_comment_url", "description": "

The API URL to get the issue comment where the secret was detected.

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

The GitHub URL for the issue comment where the secret was detected.

" } ] }, @@ -266071,6 +266099,11 @@ "name": "pull_request_title_url", "description": "

The API URL to get the pull request where the secret was detected.

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

The GitHub URL for the pull request where the secret was detected.

" } ] }, @@ -266084,6 +266117,11 @@ "name": "pull_request_body_url", "description": "

The API URL to get the pull request where the secret was detected.

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

The GitHub URL for the pull request where the secret was detected.

" } ] }, @@ -266097,6 +266135,11 @@ "name": "pull_request_comment_url", "description": "

The API URL to get the pull request comment where the secret was detected.

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

The GitHub URL for the pull request comment where the secret was detected.

" } ] }, @@ -266110,6 +266153,11 @@ "name": "pull_request_review_url", "description": "

The API URL to get the pull request review where the secret was detected.

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

The GitHub URL for the pull request review where the secret was detected.

" } ] }, @@ -266123,6 +266171,11 @@ "name": "pull_request_review_comment_url", "description": "

The API URL to get the pull request review comment where the secret was detected.

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

The GitHub URL for the pull request review comment where the secret was detected.

" } ] } diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 87b51a1d1377..1e483c87dbdd 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -1196,7 +1196,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -1391,6 +1392,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -1574,7 +1602,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -1769,6 +1798,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -1952,7 +2008,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2147,6 +2204,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -2330,7 +2414,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2525,6 +2610,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -2751,7 +2863,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2946,6 +3059,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -19006,6 +19146,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -19844,6 +19985,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -20682,6 +20824,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -21520,6 +21663,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -22358,6 +22502,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -23196,6 +23341,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -24034,6 +24180,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -24872,6 +25019,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -53941,7 +54089,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -54136,6 +54285,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -54319,7 +54495,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -54514,6 +54691,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -54742,7 +54946,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -54937,6 +55142,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -55120,7 +55352,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -55315,6 +55548,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -55498,7 +55758,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -55693,6 +55954,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -55921,7 +56209,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -56116,6 +56405,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -56299,7 +56615,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -56494,6 +56811,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -56677,7 +57021,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -56872,6 +57217,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -57055,7 +57427,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -57250,6 +57623,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -57476,7 +57876,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -57671,6 +58072,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -57899,7 +58327,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -58094,6 +58523,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -58277,7 +58733,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -58472,6 +58929,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -58655,7 +59139,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -58850,6 +59335,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -59033,7 +59545,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -59228,6 +59741,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -59454,7 +59994,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -59649,6 +60190,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -274259,6 +274827,11 @@ "name": "commit_url", "description": "

The API URL to get the associated commit resource

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

The GitHub URL to get the associated commit resource.

" } ] }, @@ -274333,6 +274906,11 @@ "name": "issue_title_url", "description": "

The API URL to get the issue where the secret was detected.

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

The GitHub URL for the issue where the secret was detected.

" } ] }, @@ -274346,6 +274924,11 @@ "name": "issue_body_url", "description": "

The API URL to get the issue where the secret was detected.

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

The GitHub URL for the issue where the secret was detected.

" } ] }, @@ -274359,6 +274942,11 @@ "name": "issue_comment_url", "description": "

The API URL to get the issue comment where the secret was detected.

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

The GitHub URL for the issue comment where the secret was detected.

" } ] }, @@ -274411,6 +274999,11 @@ "name": "pull_request_title_url", "description": "

The API URL to get the pull request where the secret was detected.

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

The GitHub URL for the pull request where the secret was detected.

" } ] }, @@ -274424,6 +275017,11 @@ "name": "pull_request_body_url", "description": "

The API URL to get the pull request where the secret was detected.

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

The GitHub URL for the pull request where the secret was detected.

" } ] }, @@ -274437,6 +275035,11 @@ "name": "pull_request_comment_url", "description": "

The API URL to get the pull request comment where the secret was detected.

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

The GitHub URL for the pull request comment where the secret was detected.

" } ] }, @@ -274450,6 +275053,11 @@ "name": "pull_request_review_url", "description": "

The API URL to get the pull request review where the secret was detected.

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

The GitHub URL for the pull request review where the secret was detected.

" } ] }, @@ -274463,6 +275071,11 @@ "name": "pull_request_review_comment_url", "description": "

The API URL to get the pull request review comment where the secret was detected.

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

The GitHub URL for the pull request review comment where the secret was detected.

" } ] } diff --git a/src/webhooks/data/ghes-3.14/schema.json b/src/webhooks/data/ghes-3.14/schema.json index 1c5b71900af8..33bd906a5ff6 100644 --- a/src/webhooks/data/ghes-3.14/schema.json +++ b/src/webhooks/data/ghes-3.14/schema.json @@ -1117,7 +1117,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -1312,6 +1313,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -1495,7 +1523,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -1690,6 +1719,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -1873,7 +1929,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2068,6 +2125,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -2251,7 +2335,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2446,6 +2531,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -2672,7 +2784,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2867,6 +2980,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true diff --git a/src/webhooks/data/ghes-3.15/schema.json b/src/webhooks/data/ghes-3.15/schema.json index 5680394ed742..f74991034fa3 100644 --- a/src/webhooks/data/ghes-3.15/schema.json +++ b/src/webhooks/data/ghes-3.15/schema.json @@ -1196,7 +1196,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -1391,6 +1392,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -1574,7 +1602,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -1769,6 +1798,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -1952,7 +2008,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2147,6 +2204,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -2330,7 +2414,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2525,6 +2610,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -2751,7 +2863,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2946,6 +3059,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true diff --git a/src/webhooks/data/ghes-3.16/schema.json b/src/webhooks/data/ghes-3.16/schema.json index 7d908431a8a6..1ab047a63281 100644 --- a/src/webhooks/data/ghes-3.16/schema.json +++ b/src/webhooks/data/ghes-3.16/schema.json @@ -1196,7 +1196,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -1391,6 +1392,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -1574,7 +1602,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -1769,6 +1798,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -1952,7 +2008,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2147,6 +2204,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -2330,7 +2414,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2525,6 +2610,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -2751,7 +2863,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2946,6 +3059,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -51076,7 +51216,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -51271,6 +51412,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -51454,7 +51622,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -51649,6 +51818,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -51832,7 +52028,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -52027,6 +52224,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -52210,7 +52434,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -52405,6 +52630,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -52631,7 +52883,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -52826,6 +53079,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true diff --git a/src/webhooks/data/ghes-3.17/schema.json b/src/webhooks/data/ghes-3.17/schema.json index 8da1d2ede2ec..6559840e62ee 100644 --- a/src/webhooks/data/ghes-3.17/schema.json +++ b/src/webhooks/data/ghes-3.17/schema.json @@ -1196,7 +1196,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -1391,6 +1392,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -1574,7 +1602,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -1769,6 +1798,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -1952,7 +2008,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2147,6 +2204,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -2330,7 +2414,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2525,6 +2610,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -2751,7 +2863,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2946,6 +3059,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -51084,7 +51224,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -51279,6 +51420,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -51462,7 +51630,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -51657,6 +51826,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -51885,7 +52081,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -52080,6 +52277,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -52263,7 +52487,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -52458,6 +52683,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -52641,7 +52893,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -52836,6 +53089,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -53064,7 +53344,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -53259,6 +53540,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -53442,7 +53750,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -53637,6 +53946,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -53820,7 +54156,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -54015,6 +54352,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -54198,7 +54562,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -54393,6 +54758,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -54619,7 +55011,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -54814,6 +55207,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -55098,7 +55518,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -55293,6 +55714,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -55476,7 +55924,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -55671,6 +56120,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -55854,7 +56330,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -56049,6 +56526,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -56232,7 +56736,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -56427,6 +56932,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -56653,7 +57185,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -56848,6 +57381,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true diff --git a/src/webhooks/data/ghes-3.18/schema.json b/src/webhooks/data/ghes-3.18/schema.json index a8c830ce1f01..64cb71368b3c 100644 --- a/src/webhooks/data/ghes-3.18/schema.json +++ b/src/webhooks/data/ghes-3.18/schema.json @@ -1196,7 +1196,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -1391,6 +1392,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -1574,7 +1602,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -1769,6 +1798,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -1952,7 +2008,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2147,6 +2204,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -2330,7 +2414,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2525,6 +2610,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -2751,7 +2863,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2946,6 +3059,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -51221,7 +51361,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -51416,6 +51557,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -51599,7 +51767,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -51794,6 +51963,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -52022,7 +52218,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -52217,6 +52414,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -52400,7 +52624,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -52595,6 +52820,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -52778,7 +53030,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -52973,6 +53226,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -53201,7 +53481,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -53396,6 +53677,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -53579,7 +53887,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -53774,6 +54083,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -53957,7 +54293,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -54152,6 +54489,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -54335,7 +54699,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -54530,6 +54895,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -54756,7 +55148,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -54951,6 +55344,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -55235,7 +55655,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -55430,6 +55851,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -55613,7 +56061,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -55808,6 +56257,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -55991,7 +56467,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -56186,6 +56663,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -56369,7 +56873,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -56564,6 +57069,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -56790,7 +57322,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -56985,6 +57518,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true diff --git a/src/webhooks/data/ghes-3.19/schema.json b/src/webhooks/data/ghes-3.19/schema.json index 91740e8405bb..72ad6937141f 100644 --- a/src/webhooks/data/ghes-3.19/schema.json +++ b/src/webhooks/data/ghes-3.19/schema.json @@ -1196,7 +1196,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -1391,6 +1392,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -1574,7 +1602,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -1769,6 +1798,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -1952,7 +2008,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2147,6 +2204,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -2330,7 +2414,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2525,6 +2610,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -2751,7 +2863,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2946,6 +3059,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -51221,7 +51361,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -51416,6 +51557,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -51599,7 +51767,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -51794,6 +51963,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -52022,7 +52218,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -52217,6 +52414,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -52400,7 +52624,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -52595,6 +52820,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -52778,7 +53030,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -52973,6 +53226,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -53201,7 +53481,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -53396,6 +53677,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -53579,7 +53887,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -53774,6 +54083,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -53957,7 +54293,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -54152,6 +54489,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -54335,7 +54699,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -54530,6 +54895,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -54756,7 +55148,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -54951,6 +55344,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -55235,7 +55655,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -55430,6 +55851,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -55613,7 +56061,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -55808,6 +56257,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -55991,7 +56467,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -56186,6 +56663,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -56369,7 +56873,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -56564,6 +57069,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -56790,7 +57322,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -56985,6 +57518,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true diff --git a/src/webhooks/data/ghes-3.20/schema.json b/src/webhooks/data/ghes-3.20/schema.json index cf4fdb8c4755..755dca96b1f8 100644 --- a/src/webhooks/data/ghes-3.20/schema.json +++ b/src/webhooks/data/ghes-3.20/schema.json @@ -1196,7 +1196,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -1391,6 +1392,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -1574,7 +1602,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -1769,6 +1798,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -1952,7 +2008,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2147,6 +2204,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -2330,7 +2414,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2525,6 +2610,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -2751,7 +2863,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -2946,6 +3059,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -51759,7 +51899,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -51954,6 +52095,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -52137,7 +52305,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -52332,6 +52501,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -52560,7 +52756,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -52755,6 +52952,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -52938,7 +53162,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -53133,6 +53358,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -53316,7 +53568,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -53511,6 +53764,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -53739,7 +54019,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -53934,6 +54215,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -54117,7 +54425,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -54312,6 +54621,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -54495,7 +54831,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -54690,6 +55027,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -54873,7 +55237,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -55068,6 +55433,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -55294,7 +55686,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -55489,6 +55882,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -55773,7 +56193,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -55968,6 +56389,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -56151,7 +56599,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -56346,6 +56795,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -56529,7 +57005,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -56724,6 +57201,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -56907,7 +57411,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -57102,6 +57607,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true @@ -57328,7 +57860,8 @@ "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", - "dependabot_alert_dismissal" + "dependabot_alert_dismissal", + "license_compliance_alert_dismissal" ] }, { @@ -57523,6 +58056,33 @@ ] } ] + }, + { + "type": "object", + "name": "License compliance alert closure request data", + "description": "

License compliance alerts that have closure requests.

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

The type of request

", + "enum": [ + "license_compliance_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "

The data related to the License compliance alerts that have closure requests.

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

The number of the alert to be closed

" + } + ] + } + ] } ], "oneOfObject": true diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 3cba42ced821..b70fe3b86bed 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "f8524e666767de6a6784abf509992ad962dd7762" + "sha": "c8a7d24eac4f40d797db33e85d5aa1480b163c27" } \ No newline at end of file From 49cbbe70a0857d90eb20670d1c994be4354f3933 Mon Sep 17 00:00:00 2001 From: a1exmozz <187176404+a1exmozz@users.noreply.github.com> Date: Thu, 2 Apr 2026 14:53:12 +0100 Subject: [PATCH 10/11] Update docs for Copilot Metrics API deprecation (#60351) Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com> --- .../copilot/concepts/copilot-usage-metrics/copilot-metrics.md | 1 - content/copilot/reference/policy-conflicts.md | 2 +- data/reusables/copilot/copilot-metrics-closing-down.md | 2 +- 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/content/copilot/concepts/copilot-usage-metrics/copilot-metrics.md b/content/copilot/concepts/copilot-usage-metrics/copilot-metrics.md index 28b1b48b7e3b..f5903da666fd 100644 --- a/content/copilot/concepts/copilot-usage-metrics/copilot-metrics.md +++ b/content/copilot/concepts/copilot-usage-metrics/copilot-metrics.md @@ -55,7 +55,6 @@ The following API resources expose {% data variables.product.prodname_copilot_sh | --- | --- | --- | | [AUTOTITLE](/rest/copilot/copilot-usage-metrics) | Advanced enterprise-, organization-, and user-level event telemetry | Provides unified telemetry across completions, chat, and agent modes. Includes usage and lines of code metrics across all IDE modes, languages, and models. Supports detailed breakdowns by feature, IDE, language, model, and user, and is the primary API resource being actively developed and maintained. | | [AUTOTITLE](/rest/copilot/copilot-user-management) | License and seat assignment | Lists assigned {% data variables.product.prodname_copilot_short %} seats for an organization or enterprise, including license state, user association, and `last_activity_at`. This API resource is the source of truth for license and seat information. | -| [AUTOTITLE](/rest/copilot/copilot-metrics) | Enterprise-, organization-, and team-level usage metrics | Provides aggregated usage data for {% data variables.product.prodname_copilot_short %} features on {% data variables.product.prodname_dotcom_the_website %} (such as pull request summaries) and some IDE-based completions and chat. Does not include Agent or Edit mode telemetry. Offers enterprise-wide and per-feature breakdowns by IDE and language. Does not include individual-level data. | ## How are metrics attributed across organizations? diff --git a/content/copilot/reference/policy-conflicts.md b/content/copilot/reference/policy-conflicts.md index 3061e2dcf556..5f865334a317 100644 --- a/content/copilot/reference/policy-conflicts.md +++ b/content/copilot/reference/policy-conflicts.md @@ -34,7 +34,7 @@ Feature, model, and privacy settings for users are set according to the **least | Policy | Availability matches | More information | | :---- | :---- | :---- | -| {% data variables.product.prodname_copilot_short %} Metrics API | Most restrictive organization | [AUTOTITLE](/rest/copilot/copilot-metrics) | +| {% data variables.product.prodname_copilot_short %} Metrics API | Most restrictive organization | {% ifversion ghec %}[AUTOTITLE](/rest/copilot/copilot-usage-metrics){% else %}Not applicable{% endif %} | | Suggestions matching public code (privacy policy) | Most restrictive organization | [AUTOTITLE](/copilot/concepts/completions/code-suggestions) | | Allow members without a {% data variables.product.prodname_copilot_short %} license to use {% data variables.copilot.copilot_code-review_short %} in {% data variables.product.prodname_dotcom_the_website %} | Most restrictive organization | [AUTOTITLE](/copilot/responsible-use/code-review) | | {% data variables.product.prodname_copilot_short %} can search the web | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat-in-github#leveraging-a-web-search-to-answer-a-question) | diff --git a/data/reusables/copilot/copilot-metrics-closing-down.md b/data/reusables/copilot/copilot-metrics-closing-down.md index 7aebb1aceb7f..5744425da45c 100644 --- a/data/reusables/copilot/copilot-metrics-closing-down.md +++ b/data/reusables/copilot/copilot-metrics-closing-down.md @@ -1,2 +1,2 @@ >[!WARNING] -> These {% data variables.product.prodname_copilot_short %} metrics endpoints will be {% data variables.release-phases.closing_down %} on April 2, 2026. We recommend using the **{% data variables.product.prodname_copilot_short %} usage metrics** endpoints instead, which provide more depth and flexibility. For more details, see [{% data variables.product.prodname_blog %}](https://github.blog/changelog/2026-01-29-closing-down-notice-of-legacy-copilot-metrics-apis/). +> These {% data variables.product.prodname_copilot_short %} metrics endpoints were closed down on April 2, 2026. Use the **{% data variables.product.prodname_copilot_short %} usage metrics** endpoints instead, which provide more depth and flexibility. For more details, see [{% data variables.product.prodname_blog %}](https://github.blog/changelog/2026-01-29-closing-down-notice-of-legacy-copilot-metrics-apis/). From 69f63943f066ebf113529bff244ab22abedb2a56 Mon Sep 17 00:00:00 2001 From: Sarita Iyer <66540150+saritai@users.noreply.github.com> Date: Thu, 2 Apr 2026 10:21:56 -0400 Subject: [PATCH 11/11] Refresh MCP instructions and update About MCP article (#60451) Co-authored-by: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com> --- content/copilot/concepts/context/mcp.md | 26 ++++++++++++------- .../use-copilot-spaces/use-copilot-spaces.md | 5 ++-- .../use-mcp/extend-copilot-chat-with-mcp.md | 11 ++++---- .../use-mcp/set-up-the-github-mcp-server.md | 13 +++++----- .../use-mcp/use-the-github-mcp-server.md | 8 +++--- data/reusables/copilot/select-agent.md | 2 +- 6 files changed, 35 insertions(+), 30 deletions(-) diff --git a/content/copilot/concepts/context/mcp.md b/content/copilot/concepts/context/mcp.md index 8a3c05ac2845..027c6298b5f3 100644 --- a/content/copilot/concepts/context/mcp.md +++ b/content/copilot/concepts/context/mcp.md @@ -36,21 +36,25 @@ category: The Model Context Protocol (MCP) is an open standard that defines how applications share context with large language models (LLMs). MCP provides a standardized way to connect AI models to different data sources and tools, enabling them to work together more effectively. -You can use MCP to extend the capabilities of {% data variables.copilot.copilot_chat_short %} by integrating it with a wide range of existing tools and services. For example, the {% data variables.product.github %} MCP server allows you to use {% data variables.copilot.copilot_chat_short %} in your IDE to perform tasks on {% data variables.product.github %}. You can also use MCP to create new tools and services that work with {% data variables.copilot.copilot_chat_short %}, allowing you to customize and enhance your experience. +You can use MCP to extend the capabilities of {% data variables.product.prodname_copilot %} by integrating it with a wide range of existing tools and services. MCP works across all major {% data variables.product.prodname_copilot_short %} surfaces—whether you're working in an IDE, using {% data variables.copilot.copilot_cli %}, or delegating tasks to the coding agent on {% data variables.product.prodname_dotcom_the_website %}. You can also use MCP to create new tools and services that work with {% data variables.product.prodname_copilot_short %}, allowing you to customize and enhance your experience. -For more information on MCP, see [the official MCP documentation](https://modelcontextprotocol.io/introduction). For information on currently available MCP servers, see [the MCP servers repository](https://github.com/modelcontextprotocol/servers/tree/main). +For more information on MCP, see [the official MCP documentation](https://modelcontextprotocol.io/introduction). For a curated list of MCP servers from partners and the community, see the [{% data variables.product.github %} MCP Registry](https://github.com/mcp). -To learn how to configure and use MCP servers with {% data variables.copilot.copilot_chat_short %}, see [AUTOTITLE](/copilot/how-tos/context/model-context-protocol/extending-copilot-chat-with-mcp). +To learn how to configure and use MCP servers, see: + +* [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp) for {% data variables.copilot.copilot_chat_short %} in your IDE +* [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers) for {% data variables.copilot.copilot_cli_short %} +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp) for {% data variables.copilot.copilot_coding_agent %} {% data reusables.copilot.mcp.mcp-policy %} ## Availability -There is currently broad support for local MCP servers in clients such as {% data variables.product.prodname_vscode %}, JetBrains IDEs, XCode, and others. - -Support for remote MCP servers is growing, with editors like {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDEs, Xcode, Eclipse, and Cursor providing this functionality with OAuth or PAT, and Windsurf supporting PAT only. +MCP is supported across the following clients: -To find out if your preferred editor supports remote MCP servers, check the documentation for your specific editor. +* **IDEs**: There is broad support for local MCP servers in clients such as {% data variables.product.prodname_vscode %}, JetBrains IDEs, Xcode, and others. Support for remote MCP servers is growing, with editors like {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDEs, Xcode, Eclipse, Cursor, and Windsurf providing this functionality with OAuth or PAT. To find out if your preferred editor supports remote MCP servers, check the documentation for your specific editor. +* **{% data variables.copilot.copilot_cli_short %}**: {% data variables.copilot.copilot_cli %} supports both local and remote MCP servers. The {% data variables.product.github %} MCP server is built in and available without additional configuration. +* **{% data variables.copilot.copilot_coding_agent %}**: {% data variables.copilot.copilot_coding_agent %} supports MCP servers configured at the repository level. The {% data variables.product.github %} MCP server and the Playwright MCP server are configured by default. ## About the {% data variables.product.github %} MCP server @@ -97,8 +101,10 @@ The {% data variables.product.github %} MCP Registry is a curated list of MCP se ## Next steps -* [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers) -* [AUTOTITLE](/copilot/how-tos/context/model-context-protocol/extending-copilot-chat-with-mcp) -* [AUTOTITLE](/copilot/how-tos/context/model-context-protocol/using-the-github-mcp-server) +* [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp)—Add MCP servers to {% data variables.copilot.copilot_chat_short %} in your IDE +* [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers)—Add MCP servers to {% data variables.copilot.copilot_cli_short %} +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp)—Add MCP servers to {% data variables.copilot.copilot_coding_agent %} +* [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/set-up-the-github-mcp-server)—Set up the {% data variables.product.github %} MCP server +* [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/use-the-github-mcp-server)—Use the {% data variables.product.github %} MCP server * [AUTOTITLE](/copilot/tutorials/enhancing-copilot-agent-mode-with-mcp) * [AUTOTITLE](/copilot/reference/customization-cheat-sheet) diff --git a/content/copilot/how-tos/provide-context/use-copilot-spaces/use-copilot-spaces.md b/content/copilot/how-tos/provide-context/use-copilot-spaces/use-copilot-spaces.md index 01ce28ac5f09..088bc3070332 100644 --- a/content/copilot/how-tos/provide-context/use-copilot-spaces/use-copilot-spaces.md +++ b/content/copilot/how-tos/provide-context/use-copilot-spaces/use-copilot-spaces.md @@ -65,8 +65,9 @@ For more detailed information on using the {% data variables.product.github %} M Note that {% data variables.copilot.copilot_spaces_short %} can only be used in agent mode in your IDE, since spaces are accessed via the {% data variables.product.github %} MCP server. -1. In your IDE, open {% data variables.copilot.copilot_chat_short %} and select **Agent** from the mode dropdown or select the **Agent** tab. - * To confirm that the {% data variables.copilot.copilot_spaces_short %} tools are enabled, in the {% data variables.copilot.copilot_chat_short %} box, click the tools icon. In the dropdown, expand the list of available tools for **MCP Server: github**, and confirm that the `get_copilot_space` and `list_copilot_spaces` tools are enabled. +1. In your IDE, open {% data variables.copilot.copilot_chat_short %} and select **Agent** from the agent dropdown menu. + * To confirm that the {% data variables.copilot.copilot_spaces_short %} tools are enabled, in the {% data variables.copilot.copilot_chat_short %} box, click the tools icon. In the tools list, expand the {% data variables.product.github %} MCP server entry and confirm that the `get_copilot_space` and `list_copilot_spaces` tools are listed and enabled. + * If you don't see the tools listed, check that you have completed the prerequisites above, including enabling the `copilot_spaces` toolset in your {% data variables.product.github %} MCP server configuration. 1. In the {% data variables.copilot.copilot_chat_short %} box, enter a prompt that references the space that you want to use as context. If you know the exact name of the space and the name of the user or organization that owns the space, you can provide that. Otherwise, {% data variables.product.prodname_copilot_short %} will automatically use the `list_copilot_spaces` tool to find spaces that match the name or text you provide and access the context from those spaces. For example, you could use either of these two prompts: diff --git a/content/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp.md b/content/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp.md index 8378280edd1e..0bd4e2960ff8 100644 --- a/content/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp.md +++ b/content/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp.md @@ -21,7 +21,7 @@ category: The Model Context Protocol (MCP) is an open standard that defines how applications share context with large language models (LLMs). For an overview of MCP, see [AUTOTITLE](/copilot/concepts/about-mcp). -For information on currently available MCP servers, see [the MCP servers repository](https://github.com/modelcontextprotocol/servers/tree/main). +For a curated list of MCP servers from partners and the community, see the [{% data variables.product.github %} MCP Registry](https://github.com/mcp). {% data reusables.copilot.mcp.mcp-policy %} @@ -45,11 +45,10 @@ MCP servers can be configured manually in a configuration file, or through the { Only MCP servers listed in the {% data variables.product.github %} MCP Registry can be added through the registry. Other servers can be configured manually. See [Configuring MCP servers manually](#configuring-mcp-servers-manually). 1. In {% data variables.product.prodname_vscode %}, open the extensions panel by clicking the extensions icon in the sidebar or pressing Ctrl+Shift+X (Windows/Linux) / Command+Shift+X (Mac). -1. In the extensions search bar, click the filter icon and select **MCP Registry** from the dropdown. -1. If it is your first time using the MCP Registry, follow the prompts on screen to enable the registry. -1. In the search bar, type the name of the MCP server you want to add and select it from the search results. -1. On the MCP server's configuration page, click **Install**. -1. To check that the MCP server is configured correctly, open the command palette by pressing Ctrl+Shift+P (Windows/Linux) / Command+Shift+P (Mac). +1. In the extensions search bar, type `@mcp` followed by the name of the MCP server you want to add. This opens the MCP server gallery and shows matching results. +1. Select the MCP server from the search results. On the MCP server's details page, click **Install**. +1. When prompted, confirm that you trust the server to start it. {% data variables.product.prodname_vscode_shortname %} discovers the server's tools and makes them available in chat. +1. To verify that the MCP server is configured correctly, open the command palette by pressing Ctrl+Shift+P (Windows/Linux) / Command+Shift+P (Mac). 1. Type and select **MCP: List Servers**. You should see the MCP server listed as a configured server. ### Configuring MCP servers manually diff --git a/content/copilot/how-tos/provide-context/use-mcp/set-up-the-github-mcp-server.md b/content/copilot/how-tos/provide-context/use-mcp/set-up-the-github-mcp-server.md index a3cbb87e4814..1c10e4a7e6c8 100644 --- a/content/copilot/how-tos/provide-context/use-mcp/set-up-the-github-mcp-server.md +++ b/content/copilot/how-tos/provide-context/use-mcp/set-up-the-github-mcp-server.md @@ -36,17 +36,16 @@ For the latest information and updates, see the [{% data variables.product.githu The {% data variables.product.github %} MCP server in {% data variables.product.prodname_vscode %} can be configured remotely or locally. The remote {% data variables.product.github %} MCP server is hosted by {% data variables.product.github %} and is the recommended option for most users. The local {% data variables.product.github %} MCP server is hosted on your machine and is recommended for users who want to customize their setup or have specific security requirements. -The steps below describe remote configuration through the MCP marketplace in {% data variables.product.prodname_vscode %}'s extension panel. The MCP marketplace is powered by the {% data variables.product.github %} MCP Registry. See [MCP Registry](https://github.com/mcp). +The steps below describe remote configuration through the MCP Registry view in {% data variables.product.prodname_vscode %}'s extensions panel. This view is backed by the {% data variables.product.github %} MCP Registry. See [{% data variables.product.github %} MCP Registry](https://github.com/mcp). For information on manually configuring the remote or local {% data variables.product.github %} MCP server, see the [{% data variables.product.github %} MCP server documentation](https://github.com/mcp/io.github.github/github-mcp-server?ref_product=copilot&ref_type=engagement&ref_style=text). 1. In {% data variables.product.prodname_vscode %}, open the extensions panel by clicking the extensions icon in the sidebar or pressing Ctrl+Shift+X (Windows/Linux) / Command+Shift+X (Mac). -1. In the extensions search bar, click the filter icon and select **MCP Server** from the dropdown. -1. If it is your first time using the MCP Servers Marketplace, follow the prompts on screen to enable the Marketplace. -1. In the search bar, type `github` and select the {% data variables.product.github %} MCP server from the search results. -1. On the {% data variables.product.github %} MCP server configuration page, click **Install**. -1. To check that the {% data variables.product.github %} MCP server is configured correctly, open the command palette by pressing Ctrl+Shift+P (Windows/Linux) / Command+Shift+P (Mac). -1. Type and select **MCP: List Servers**. You should see `github` listed as a configured server. +1. In the extensions search bar, type `@mcp github` to search the MCP server gallery. +1. Select the {% data variables.product.github %} MCP server from the search results. On the details page, click **Install**. +1. When prompted, confirm that you trust the server to start it. +1. To verify that the {% data variables.product.github %} MCP server is configured correctly, open the command palette by pressing Ctrl+Shift+P (Windows/Linux) / Command+Shift+P (Mac). +1. Type and select **MCP: List Servers**. You should see the {% data variables.product.github %} MCP server listed as a configured server. {% endvscode %} diff --git a/content/copilot/how-tos/provide-context/use-mcp/use-the-github-mcp-server.md b/content/copilot/how-tos/provide-context/use-mcp/use-the-github-mcp-server.md index fad9e2ac2025..e545e40c03e9 100644 --- a/content/copilot/how-tos/provide-context/use-mcp/use-the-github-mcp-server.md +++ b/content/copilot/how-tos/provide-context/use-mcp/use-the-github-mcp-server.md @@ -35,8 +35,8 @@ The {% data variables.product.github %} MCP server enables you to perform a wide {% data reusables.copilot.open-chat-vs-code %} {% data reusables.copilot.select-agent %} -1. To see the available actions, in the {% data variables.copilot.copilot_chat_short %} box, click the **Select tools** icon. - * In the **Tools** dropdown, under **MCP Server: {% data variables.product.github %}**, you will see a list of available actions. +1. To see the available actions, in the {% data variables.copilot.copilot_chat_short %} box, click the **Configure tools** icon. + * If you expand the {% data variables.product.github %} MCP server entry, you will see a list of available tools. 1. In the {% data variables.copilot.copilot_chat_short %} box, type a command or question related to the action you want to perform, and press **Enter**. * For example, you can ask the {% data variables.product.github %} MCP server to create a new issue, list pull requests, or retrieve repository information. 1. The {% data variables.product.github %} MCP server will process your request and provide a response in the chat interface. @@ -98,7 +98,7 @@ The {% data variables.product.github %} MCP server enables you to perform a wide ![Screenshot of the {% data variables.copilot.copilot_chat %} icon in the Activity Bar.](/assets/images/help/copilot/jetbrains-copilot-chat-icon.png) 1. At the top of the chat panel, click the **Agent** tab. 1. To see the available actions, in the {% data variables.copilot.copilot_chat_short %} box, click the tools icon. - * Under **MCP Server: {% data variables.product.github %}**, you will see a list of available actions. + * You will see a list of available actions from the {% data variables.product.github %} MCP server. 1. In the {% data variables.copilot.copilot_chat_short %} box, type a command or question related to the action you want to perform, and press **Enter**. * For example, you can ask the {% data variables.product.github %} MCP server to create a new issue, list pull requests, or retrieve repository information. 1. The {% data variables.product.github %} MCP server will process your request and provide a response in the chat interface. @@ -127,7 +127,7 @@ The {% data variables.product.github %} MCP server enables you to perform a wide 1. To open the chat view, click **Editor** in the menu bar, then click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} {% data variables.product.prodname_copilot_short %}** then **Open Chat**. {% data variables.copilot.copilot_chat_short %} opens in a new window. 1. At the bottom of the chat panel, select **Agent**. 1. To see the available actions, in the {% data variables.copilot.copilot_chat_short %} box, click the tools icon. - * Under **MCP Server: {% data variables.product.github %}**, you will see a list of available actions. + * You will see a list of available actions from the {% data variables.product.github %} MCP server. 1. In the {% data variables.copilot.copilot_chat_short %} box, type a command or question related to the action you want to perform, and press **Enter**. * For example, you can ask the {% data variables.product.github %} MCP server to create a new issue, list pull requests, or retrieve repository information. 1. The {% data variables.product.github %} MCP server will process your request and provide a response in the chat interface. diff --git a/data/reusables/copilot/select-agent.md b/data/reusables/copilot/select-agent.md index 8042627be020..5c7eeaa26cbd 100644 --- a/data/reusables/copilot/select-agent.md +++ b/data/reusables/copilot/select-agent.md @@ -1 +1 @@ -1. In the {% data variables.copilot.copilot_chat_short %} box, select **Agent** from the popup menu. +1. In the {% data variables.copilot.copilot_chat_short %} box, select **Agent** from the agent dropdown menu.