diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 469d0704d9..0bb05b64a7 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -789,26 +789,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -818,6 +817,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -894,10 +897,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1186,7 +1188,7 @@ }, "post": { "summary": "Create a task", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository\n", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository.\n", "tags": [ "agent-tasks" ], @@ -1228,33 +1230,21 @@ "schema": { "type": "object", "required": [ - "event_content" + "prompt" ], "properties": { - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID (optional, defaults to coding agent)" - }, - "problem_statement": { - "type": "string", - "description": "Additional prompting for the agent" - }, - "event_content": { + "prompt": { "type": "string", - "description": "User's written prompt" + "description": "The user's prompt for the agent" }, "model": { "type": "string", "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`" }, - "custom_agent": { - "type": "string", - "description": "Custom agent identifier" - }, "create_pull_request": { "type": "boolean", - "description": "Whether to create a PR" + "description": "Whether to create a PR.", + "default": false }, "base_ref": { "type": "string", @@ -1265,8 +1255,7 @@ "examples": { "default": { "value": { - "event_content": "Fix the login button on the homepage", - "create_pull_request": true, + "prompt": "Fix the login button on the homepage", "base_ref": "main" } } @@ -1405,26 +1394,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1434,6 +1422,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1900,26 +1892,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1929,6 +1920,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -2022,15 +2017,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -2064,47 +2050,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -2113,20 +2062,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", @@ -2167,10 +2106,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -2195,9 +2133,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] } @@ -2720,26 +2659,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -2749,6 +2687,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -2823,10 +2765,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -3222,26 +3163,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -3251,6 +3191,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -3344,15 +3288,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -3386,47 +3321,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -3435,20 +3333,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", @@ -3489,10 +3377,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -3517,9 +3404,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] } @@ -32930,6 +32818,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-providers" + }, { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, @@ -66968,6 +66859,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-providers" + }, { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, @@ -127199,6 +127093,13 @@ ], "description": "The provider of the secret that was detected." }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -143110,6 +143011,13 @@ ], "description": "The provider of the secret that was detected." }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -159569,6 +159477,13 @@ ], "description": "The provider of the secret that was detected." }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected." + }, "validity": { "type": "string", "description": "The token status as of the latest validity check.", @@ -331170,7 +331085,16 @@ "secret-scanning-alert-exclude-providers": { "name": "exclude_providers", "in": "query", - "description": "A comma-separated list of provider names to exclude from the results.", + "description": "A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `providers` parameter.", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-alert-providers": { + "name": "providers", + "in": "query", + "description": "A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `exclude_providers` parameter.", "required": false, "schema": { "type": "string" diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 33fe6be9d4..be203bacfe 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -550,28 +550,32 @@ paths: type: type: string enum: - - github_resource + - pull - branch - description: Discriminator for data shape + description: 'Type of artifact. Available Values: + `pull`, `branch`. + + ' data: oneOf: - type: object description: A GitHub resource (pull request, issue, etc.) + required: + - id properties: id: type: integer format: int64 description: GitHub resource ID - type: - type: string - description: Resource type (e.g., pull_request, - issue) global_id: type: string description: GraphQL global ID - type: object description: A Git branch reference + required: + - head_ref + - base_ref properties: head_ref: type: string @@ -625,10 +629,9 @@ paths: session_count: 1 artifacts: - provider: github - type: github_resource + type: pull data: id: 42 - type: pull_request archived_at: created_at: '2025-01-01T00:00:00Z' updated_at: '2025-01-01T01:00:00Z' @@ -858,7 +861,7 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Creates a new task for a repository + Creates a new task for a repository. tags: - agent-tasks operationId: agent-tasks/create-task @@ -890,18 +893,11 @@ paths: schema: type: object required: - - event_content + - prompt properties: - agent_id: - type: integer - format: int64 - description: Agent ID (optional, defaults to coding agent) - problem_statement: - type: string - description: Additional prompting for the agent - event_content: + prompt: type: string - description: User's written prompt + description: The user's prompt for the agent model: type: string description: 'The model to use for this task. The allowed models @@ -909,20 +905,17 @@ paths: plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`' - custom_agent: - type: string - description: Custom agent identifier create_pull_request: type: boolean - description: Whether to create a PR + description: Whether to create a PR. + default: false base_ref: type: string description: Base ref for new branch/PR examples: default: value: - event_content: Fix the login button on the homepage - create_pull_request: true + prompt: Fix the login button on the homepage base_ref: main responses: '201': @@ -1027,26 +1020,31 @@ paths: type: type: string enum: - - github_resource + - pull - branch - description: Discriminator for data shape + description: 'Type of artifact. Available Values: `pull`, + `branch`. + + ' data: oneOf: - type: object description: A GitHub resource (pull request, issue, etc.) + required: + - id properties: id: type: integer format: int64 description: GitHub resource ID - type: - type: string - description: Resource type (e.g., pull_request, issue) global_id: type: string description: GraphQL global ID - type: object description: A Git branch reference + required: + - head_ref + - base_ref properties: head_ref: type: string @@ -1409,28 +1407,32 @@ paths: type: type: string enum: - - github_resource + - pull - branch - description: Discriminator for data shape + description: 'Type of artifact. Available Values: `pull`, + `branch`. + + ' data: oneOf: - type: object description: A GitHub resource (pull request, issue, etc.) + required: + - id properties: id: type: integer format: int64 description: GitHub resource ID - type: - type: string - description: Resource type (e.g., pull_request, - issue) global_id: type: string description: GraphQL global ID - type: object description: A Git branch reference + required: + - head_ref + - base_ref properties: head_ref: type: string @@ -1498,13 +1500,6 @@ paths: 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 @@ -1532,54 +1527,18 @@ paths: 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: + prompt: type: string description: Content of the triggering event - event_identifiers: - type: array - items: - type: string - description: Identifiers for tracking - resource_type: - type: string - description: Type of resource associated with this session - resource_id: - type: integer - format: int64 - description: Resource ID - resource_number: - type: integer - format: int32 - description: Resource number (e.g., PR number) - resource_global_id: - type: string - description: GraphQL global ID of the resource - resource_state: - type: string - description: State of the associated resource head_ref: type: string description: Head branch name 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 @@ -1606,10 +1565,9 @@ paths: session_count: 1 artifacts: - provider: github - type: github_resource + type: pull data: id: 42 - type: pull_request archived_at: created_at: '2025-01-01T00:00:00Z' updated_at: '2025-01-01T01:00:00Z' @@ -1627,9 +1585,10 @@ paths: created_at: '2025-01-01T00:00:00Z' updated_at: '2025-01-01T01:00:00Z' completed_at: '2025-01-01T01:00:00Z' - event_content: Fix the login button on the homepage + prompt: Fix the login button on the homepage head_ref: copilot/fix-1 base_ref: main + model: claude-sonnet-4.6 '400': description: Bad request content: @@ -2043,28 +2002,32 @@ paths: type: type: string enum: - - github_resource + - pull - branch - description: Discriminator for data shape + description: 'Type of artifact. Available Values: + `pull`, `branch`. + + ' data: oneOf: - type: object description: A GitHub resource (pull request, issue, etc.) + required: + - id properties: id: type: integer format: int64 description: GitHub resource ID - type: - type: string - description: Resource type (e.g., pull_request, - issue) global_id: type: string description: GraphQL global ID - type: object description: A Git branch reference + required: + - head_ref + - base_ref properties: head_ref: type: string @@ -2116,10 +2079,9 @@ paths: session_count: 1 artifacts: - provider: github - type: github_resource + type: pull data: id: 42 - type: pull_request archived_at: created_at: '2025-01-01T00:00:00Z' updated_at: '2025-01-01T01:00:00Z' @@ -2429,28 +2391,32 @@ paths: type: type: string enum: - - github_resource + - pull - branch - description: Discriminator for data shape + description: 'Type of artifact. Available Values: `pull`, + `branch`. + + ' data: oneOf: - type: object description: A GitHub resource (pull request, issue, etc.) + required: + - id properties: id: type: integer format: int64 description: GitHub resource ID - type: - type: string - description: Resource type (e.g., pull_request, - issue) global_id: type: string description: GraphQL global ID - type: object description: A Git branch reference + required: + - head_ref + - base_ref properties: head_ref: type: string @@ -2518,13 +2484,6 @@ paths: 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 @@ -2552,54 +2511,18 @@ paths: 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: + prompt: type: string description: Content of the triggering event - event_identifiers: - type: array - items: - type: string - description: Identifiers for tracking - resource_type: - type: string - description: Type of resource associated with this session - resource_id: - type: integer - format: int64 - description: Resource ID - resource_number: - type: integer - format: int32 - description: Resource number (e.g., PR number) - resource_global_id: - type: string - description: GraphQL global ID of the resource - resource_state: - type: string - description: State of the associated resource head_ref: type: string description: Head branch name 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 @@ -2626,10 +2549,9 @@ paths: session_count: 1 artifacts: - provider: github - type: github_resource + type: pull data: id: 42 - type: pull_request archived_at: created_at: '2025-01-01T00:00:00Z' updated_at: '2025-01-01T01:00:00Z' @@ -2647,9 +2569,10 @@ paths: created_at: '2025-01-01T00:00:00Z' updated_at: '2025-01-01T01:00:00Z' completed_at: '2025-01-01T01:00:00Z' - event_content: Fix the login button on the homepage + prompt: Fix the login button on the homepage head_ref: copilot/fix-1 base_ref: main + model: claude-sonnet-4.6 '400': description: Problems parsing request content: @@ -24022,6 +23945,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-exclude-secret-types" - "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" + - "$ref": "#/components/parameters/secret-scanning-alert-providers" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" @@ -48777,6 +48701,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-exclude-secret-types" - "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" + - "$ref": "#/components/parameters/secret-scanning-alert-providers" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" @@ -92493,6 +92418,13 @@ components: - string - 'null' description: The provider of the secret that was detected. + provider_slug: + type: + - string + - 'null' + description: The slug identifier for the provider of the secret that was + detected. Use this value for filtering by provider with the `providers` + or `exclude_providers` parameters. secret: type: string description: The secret that was detected. @@ -103807,6 +103739,13 @@ components: - string - 'null' description: The provider of the secret that was detected. + provider_slug: + type: + - string + - 'null' + description: The slug identifier for the provider of the secret that was + detected. Use this value for filtering by provider with the `providers` + or `exclude_providers` parameters. secret: type: string description: The secret that was detected. @@ -115986,6 +115925,12 @@ components: - string - 'null' description: The provider of the secret that was detected. + provider_slug: + type: + - string + - 'null' + description: The slug identifier for the provider of the secret that was + detected. validity: type: string description: The token status as of the latest validity check. @@ -247729,7 +247674,22 @@ components: secret-scanning-alert-exclude-providers: name: exclude_providers in: query - description: A comma-separated list of provider names to exclude from the results. + description: |- + A comma-separated list of provider slugs to exclude from the results. + Provider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`). + You can find the provider slug in the `provider_slug` field of each alert. + Cannot be combined with the `providers` parameter. + required: false + schema: + type: string + secret-scanning-alert-providers: + name: providers + in: query + description: |- + A comma-separated list of provider slugs to filter by. + Provider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`). + You can find the provider slug in the `provider_slug` field of each alert. + Cannot be combined with the `exclude_providers` parameter. required: false schema: type: string diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.json b/descriptions-next/api.github.com/api.github.com.2026-03-10.json index 8d54567f2e..59d5596b12 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.json @@ -789,26 +789,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -818,6 +817,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -894,10 +897,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1186,7 +1188,7 @@ }, "post": { "summary": "Create a task", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository\n", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository.\n", "tags": [ "agent-tasks" ], @@ -1228,33 +1230,21 @@ "schema": { "type": "object", "required": [ - "event_content" + "prompt" ], "properties": { - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID (optional, defaults to coding agent)" - }, - "problem_statement": { - "type": "string", - "description": "Additional prompting for the agent" - }, - "event_content": { + "prompt": { "type": "string", - "description": "User's written prompt" + "description": "The user's prompt for the agent" }, "model": { "type": "string", "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`" }, - "custom_agent": { - "type": "string", - "description": "Custom agent identifier" - }, "create_pull_request": { "type": "boolean", - "description": "Whether to create a PR" + "description": "Whether to create a PR.", + "default": false }, "base_ref": { "type": "string", @@ -1265,8 +1255,7 @@ "examples": { "default": { "value": { - "event_content": "Fix the login button on the homepage", - "create_pull_request": true, + "prompt": "Fix the login button on the homepage", "base_ref": "main" } } @@ -1405,26 +1394,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1434,6 +1422,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1900,26 +1892,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1929,6 +1920,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -2022,15 +2017,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -2064,47 +2050,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -2113,20 +2062,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", @@ -2167,10 +2106,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -2195,9 +2133,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] } @@ -2720,26 +2659,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -2749,6 +2687,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -2823,10 +2765,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -3222,26 +3163,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -3251,6 +3191,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -3344,15 +3288,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -3386,47 +3321,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -3435,20 +3333,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", @@ -3489,10 +3377,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -3517,9 +3404,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] } @@ -32885,6 +32773,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-providers" + }, { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, @@ -66874,6 +66765,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-providers" + }, { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, @@ -126592,6 +126486,13 @@ ], "description": "The provider of the secret that was detected." }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -142437,6 +142338,13 @@ ], "description": "The provider of the secret that was detected." }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -159105,6 +159013,13 @@ ], "description": "The provider of the secret that was detected." }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected." + }, "validity": { "type": "string", "description": "The token status as of the latest validity check.", @@ -330324,7 +330239,16 @@ "secret-scanning-alert-exclude-providers": { "name": "exclude_providers", "in": "query", - "description": "A comma-separated list of provider names to exclude from the results.", + "description": "A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `providers` parameter.", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-alert-providers": { + "name": "providers", + "in": "query", + "description": "A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `exclude_providers` parameter.", "required": false, "schema": { "type": "string" diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml index 80fc041b1d..b3f7046722 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml @@ -550,28 +550,32 @@ paths: type: type: string enum: - - github_resource + - pull - branch - description: Discriminator for data shape + description: 'Type of artifact. Available Values: + `pull`, `branch`. + + ' data: oneOf: - type: object description: A GitHub resource (pull request, issue, etc.) + required: + - id properties: id: type: integer format: int64 description: GitHub resource ID - type: - type: string - description: Resource type (e.g., pull_request, - issue) global_id: type: string description: GraphQL global ID - type: object description: A Git branch reference + required: + - head_ref + - base_ref properties: head_ref: type: string @@ -625,10 +629,9 @@ paths: session_count: 1 artifacts: - provider: github - type: github_resource + type: pull data: id: 42 - type: pull_request archived_at: created_at: '2025-01-01T00:00:00Z' updated_at: '2025-01-01T01:00:00Z' @@ -858,7 +861,7 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Creates a new task for a repository + Creates a new task for a repository. tags: - agent-tasks operationId: agent-tasks/create-task @@ -890,18 +893,11 @@ paths: schema: type: object required: - - event_content + - prompt properties: - agent_id: - type: integer - format: int64 - description: Agent ID (optional, defaults to coding agent) - problem_statement: - type: string - description: Additional prompting for the agent - event_content: + prompt: type: string - description: User's written prompt + description: The user's prompt for the agent model: type: string description: 'The model to use for this task. The allowed models @@ -909,20 +905,17 @@ paths: plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`' - custom_agent: - type: string - description: Custom agent identifier create_pull_request: type: boolean - description: Whether to create a PR + description: Whether to create a PR. + default: false base_ref: type: string description: Base ref for new branch/PR examples: default: value: - event_content: Fix the login button on the homepage - create_pull_request: true + prompt: Fix the login button on the homepage base_ref: main responses: '201': @@ -1027,26 +1020,31 @@ paths: type: type: string enum: - - github_resource + - pull - branch - description: Discriminator for data shape + description: 'Type of artifact. Available Values: `pull`, + `branch`. + + ' data: oneOf: - type: object description: A GitHub resource (pull request, issue, etc.) + required: + - id properties: id: type: integer format: int64 description: GitHub resource ID - type: - type: string - description: Resource type (e.g., pull_request, issue) global_id: type: string description: GraphQL global ID - type: object description: A Git branch reference + required: + - head_ref + - base_ref properties: head_ref: type: string @@ -1409,28 +1407,32 @@ paths: type: type: string enum: - - github_resource + - pull - branch - description: Discriminator for data shape + description: 'Type of artifact. Available Values: `pull`, + `branch`. + + ' data: oneOf: - type: object description: A GitHub resource (pull request, issue, etc.) + required: + - id properties: id: type: integer format: int64 description: GitHub resource ID - type: - type: string - description: Resource type (e.g., pull_request, - issue) global_id: type: string description: GraphQL global ID - type: object description: A Git branch reference + required: + - head_ref + - base_ref properties: head_ref: type: string @@ -1498,13 +1500,6 @@ paths: 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 @@ -1532,54 +1527,18 @@ paths: 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: + prompt: type: string description: Content of the triggering event - event_identifiers: - type: array - items: - type: string - description: Identifiers for tracking - resource_type: - type: string - description: Type of resource associated with this session - resource_id: - type: integer - format: int64 - description: Resource ID - resource_number: - type: integer - format: int32 - description: Resource number (e.g., PR number) - resource_global_id: - type: string - description: GraphQL global ID of the resource - resource_state: - type: string - description: State of the associated resource head_ref: type: string description: Head branch name 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 @@ -1606,10 +1565,9 @@ paths: session_count: 1 artifacts: - provider: github - type: github_resource + type: pull data: id: 42 - type: pull_request archived_at: created_at: '2025-01-01T00:00:00Z' updated_at: '2025-01-01T01:00:00Z' @@ -1627,9 +1585,10 @@ paths: created_at: '2025-01-01T00:00:00Z' updated_at: '2025-01-01T01:00:00Z' completed_at: '2025-01-01T01:00:00Z' - event_content: Fix the login button on the homepage + prompt: Fix the login button on the homepage head_ref: copilot/fix-1 base_ref: main + model: claude-sonnet-4.6 '400': description: Bad request content: @@ -2043,28 +2002,32 @@ paths: type: type: string enum: - - github_resource + - pull - branch - description: Discriminator for data shape + description: 'Type of artifact. Available Values: + `pull`, `branch`. + + ' data: oneOf: - type: object description: A GitHub resource (pull request, issue, etc.) + required: + - id properties: id: type: integer format: int64 description: GitHub resource ID - type: - type: string - description: Resource type (e.g., pull_request, - issue) global_id: type: string description: GraphQL global ID - type: object description: A Git branch reference + required: + - head_ref + - base_ref properties: head_ref: type: string @@ -2116,10 +2079,9 @@ paths: session_count: 1 artifacts: - provider: github - type: github_resource + type: pull data: id: 42 - type: pull_request archived_at: created_at: '2025-01-01T00:00:00Z' updated_at: '2025-01-01T01:00:00Z' @@ -2429,28 +2391,32 @@ paths: type: type: string enum: - - github_resource + - pull - branch - description: Discriminator for data shape + description: 'Type of artifact. Available Values: `pull`, + `branch`. + + ' data: oneOf: - type: object description: A GitHub resource (pull request, issue, etc.) + required: + - id properties: id: type: integer format: int64 description: GitHub resource ID - type: - type: string - description: Resource type (e.g., pull_request, - issue) global_id: type: string description: GraphQL global ID - type: object description: A Git branch reference + required: + - head_ref + - base_ref properties: head_ref: type: string @@ -2518,13 +2484,6 @@ paths: 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 @@ -2552,54 +2511,18 @@ paths: 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: + prompt: type: string description: Content of the triggering event - event_identifiers: - type: array - items: - type: string - description: Identifiers for tracking - resource_type: - type: string - description: Type of resource associated with this session - resource_id: - type: integer - format: int64 - description: Resource ID - resource_number: - type: integer - format: int32 - description: Resource number (e.g., PR number) - resource_global_id: - type: string - description: GraphQL global ID of the resource - resource_state: - type: string - description: State of the associated resource head_ref: type: string description: Head branch name 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 @@ -2626,10 +2549,9 @@ paths: session_count: 1 artifacts: - provider: github - type: github_resource + type: pull data: id: 42 - type: pull_request archived_at: created_at: '2025-01-01T00:00:00Z' updated_at: '2025-01-01T01:00:00Z' @@ -2647,9 +2569,10 @@ paths: created_at: '2025-01-01T00:00:00Z' updated_at: '2025-01-01T01:00:00Z' completed_at: '2025-01-01T01:00:00Z' - event_content: Fix the login button on the homepage + prompt: Fix the login button on the homepage head_ref: copilot/fix-1 base_ref: main + model: claude-sonnet-4.6 '400': description: Problems parsing request content: @@ -23989,6 +23912,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-exclude-secret-types" - "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" + - "$ref": "#/components/parameters/secret-scanning-alert-providers" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" @@ -48700,6 +48624,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-exclude-secret-types" - "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" + - "$ref": "#/components/parameters/secret-scanning-alert-providers" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" @@ -92049,6 +91974,13 @@ components: - string - 'null' description: The provider of the secret that was detected. + provider_slug: + type: + - string + - 'null' + description: The slug identifier for the provider of the secret that was + detected. Use this value for filtering by provider with the `providers` + or `exclude_providers` parameters. secret: type: string description: The secret that was detected. @@ -103317,6 +103249,13 @@ components: - string - 'null' description: The provider of the secret that was detected. + provider_slug: + type: + - string + - 'null' + description: The slug identifier for the provider of the secret that was + detected. Use this value for filtering by provider with the `providers` + or `exclude_providers` parameters. secret: type: string description: The secret that was detected. @@ -115650,6 +115589,12 @@ components: - string - 'null' description: The provider of the secret that was detected. + provider_slug: + type: + - string + - 'null' + description: The slug identifier for the provider of the secret that was + detected. validity: type: string description: The token status as of the latest validity check. @@ -247033,7 +246978,22 @@ components: secret-scanning-alert-exclude-providers: name: exclude_providers in: query - description: A comma-separated list of provider names to exclude from the results. + description: |- + A comma-separated list of provider slugs to exclude from the results. + Provider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`). + You can find the provider slug in the `provider_slug` field of each alert. + Cannot be combined with the `providers` parameter. + required: false + schema: + type: string + secret-scanning-alert-providers: + name: providers + in: query + description: |- + A comma-separated list of provider slugs to filter by. + Provider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`). + You can find the provider slug in the `provider_slug` field of each alert. + Cannot be combined with the `exclude_providers` parameter. required: false schema: type: string diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index a909195a03..db83bed8fe 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -789,26 +789,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -818,6 +817,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -894,10 +897,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1186,7 +1188,7 @@ }, "post": { "summary": "Create a task", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository\n", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository.\n", "tags": [ "agent-tasks" ], @@ -1228,33 +1230,21 @@ "schema": { "type": "object", "required": [ - "event_content" + "prompt" ], "properties": { - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID (optional, defaults to coding agent)" - }, - "problem_statement": { - "type": "string", - "description": "Additional prompting for the agent" - }, - "event_content": { + "prompt": { "type": "string", - "description": "User's written prompt" + "description": "The user's prompt for the agent" }, "model": { "type": "string", "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`" }, - "custom_agent": { - "type": "string", - "description": "Custom agent identifier" - }, "create_pull_request": { "type": "boolean", - "description": "Whether to create a PR" + "description": "Whether to create a PR.", + "default": false }, "base_ref": { "type": "string", @@ -1265,8 +1255,7 @@ "examples": { "default": { "value": { - "event_content": "Fix the login button on the homepage", - "create_pull_request": true, + "prompt": "Fix the login button on the homepage", "base_ref": "main" } } @@ -1405,26 +1394,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1434,6 +1422,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1900,26 +1892,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1929,6 +1920,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -2022,15 +2017,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -2064,47 +2050,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -2113,20 +2062,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", @@ -2167,10 +2106,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -2195,9 +2133,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] } @@ -2720,26 +2659,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -2749,6 +2687,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -2823,10 +2765,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -3222,26 +3163,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -3251,6 +3191,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -3344,15 +3288,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -3386,47 +3321,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -3435,20 +3333,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", @@ -3489,10 +3377,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -3517,9 +3404,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] } @@ -33122,6 +33010,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-providers" + }, { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, @@ -67270,6 +67161,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-providers" + }, { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, @@ -128068,6 +127962,13 @@ ], "description": "The provider of the secret that was detected." }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -144246,6 +144147,13 @@ ], "description": "The provider of the secret that was detected." }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -160812,6 +160720,13 @@ ], "description": "The provider of the secret that was detected." }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected." + }, "validity": { "type": "string", "description": "The token status as of the latest validity check.", @@ -333078,7 +332993,16 @@ "secret-scanning-alert-exclude-providers": { "name": "exclude_providers", "in": "query", - "description": "A comma-separated list of provider names to exclude from the results.", + "description": "A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `providers` parameter.", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-alert-providers": { + "name": "providers", + "in": "query", + "description": "A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `exclude_providers` parameter.", "required": false, "schema": { "type": "string" diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 36784eb73c..0ceb2c080a 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -550,28 +550,32 @@ paths: type: type: string enum: - - github_resource + - pull - branch - description: Discriminator for data shape + description: 'Type of artifact. Available Values: + `pull`, `branch`. + + ' data: oneOf: - type: object description: A GitHub resource (pull request, issue, etc.) + required: + - id properties: id: type: integer format: int64 description: GitHub resource ID - type: - type: string - description: Resource type (e.g., pull_request, - issue) global_id: type: string description: GraphQL global ID - type: object description: A Git branch reference + required: + - head_ref + - base_ref properties: head_ref: type: string @@ -625,10 +629,9 @@ paths: session_count: 1 artifacts: - provider: github - type: github_resource + type: pull data: id: 42 - type: pull_request archived_at: created_at: '2025-01-01T00:00:00Z' updated_at: '2025-01-01T01:00:00Z' @@ -858,7 +861,7 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Creates a new task for a repository + Creates a new task for a repository. tags: - agent-tasks operationId: agent-tasks/create-task @@ -890,18 +893,11 @@ paths: schema: type: object required: - - event_content + - prompt properties: - agent_id: - type: integer - format: int64 - description: Agent ID (optional, defaults to coding agent) - problem_statement: - type: string - description: Additional prompting for the agent - event_content: + prompt: type: string - description: User's written prompt + description: The user's prompt for the agent model: type: string description: 'The model to use for this task. The allowed models @@ -909,20 +905,17 @@ paths: plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`' - custom_agent: - type: string - description: Custom agent identifier create_pull_request: type: boolean - description: Whether to create a PR + description: Whether to create a PR. + default: false base_ref: type: string description: Base ref for new branch/PR examples: default: value: - event_content: Fix the login button on the homepage - create_pull_request: true + prompt: Fix the login button on the homepage base_ref: main responses: '201': @@ -1027,26 +1020,31 @@ paths: type: type: string enum: - - github_resource + - pull - branch - description: Discriminator for data shape + description: 'Type of artifact. Available Values: `pull`, + `branch`. + + ' data: oneOf: - type: object description: A GitHub resource (pull request, issue, etc.) + required: + - id properties: id: type: integer format: int64 description: GitHub resource ID - type: - type: string - description: Resource type (e.g., pull_request, issue) global_id: type: string description: GraphQL global ID - type: object description: A Git branch reference + required: + - head_ref + - base_ref properties: head_ref: type: string @@ -1409,28 +1407,32 @@ paths: type: type: string enum: - - github_resource + - pull - branch - description: Discriminator for data shape + description: 'Type of artifact. Available Values: `pull`, + `branch`. + + ' data: oneOf: - type: object description: A GitHub resource (pull request, issue, etc.) + required: + - id properties: id: type: integer format: int64 description: GitHub resource ID - type: - type: string - description: Resource type (e.g., pull_request, - issue) global_id: type: string description: GraphQL global ID - type: object description: A Git branch reference + required: + - head_ref + - base_ref properties: head_ref: type: string @@ -1498,13 +1500,6 @@ paths: 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 @@ -1532,54 +1527,18 @@ paths: 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: + prompt: type: string description: Content of the triggering event - event_identifiers: - type: array - items: - type: string - description: Identifiers for tracking - resource_type: - type: string - description: Type of resource associated with this session - resource_id: - type: integer - format: int64 - description: Resource ID - resource_number: - type: integer - format: int32 - description: Resource number (e.g., PR number) - resource_global_id: - type: string - description: GraphQL global ID of the resource - resource_state: - type: string - description: State of the associated resource head_ref: type: string description: Head branch name 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 @@ -1606,10 +1565,9 @@ paths: session_count: 1 artifacts: - provider: github - type: github_resource + type: pull data: id: 42 - type: pull_request archived_at: created_at: '2025-01-01T00:00:00Z' updated_at: '2025-01-01T01:00:00Z' @@ -1627,9 +1585,10 @@ paths: created_at: '2025-01-01T00:00:00Z' updated_at: '2025-01-01T01:00:00Z' completed_at: '2025-01-01T01:00:00Z' - event_content: Fix the login button on the homepage + prompt: Fix the login button on the homepage head_ref: copilot/fix-1 base_ref: main + model: claude-sonnet-4.6 '400': description: Bad request content: @@ -2043,28 +2002,32 @@ paths: type: type: string enum: - - github_resource + - pull - branch - description: Discriminator for data shape + description: 'Type of artifact. Available Values: + `pull`, `branch`. + + ' data: oneOf: - type: object description: A GitHub resource (pull request, issue, etc.) + required: + - id properties: id: type: integer format: int64 description: GitHub resource ID - type: - type: string - description: Resource type (e.g., pull_request, - issue) global_id: type: string description: GraphQL global ID - type: object description: A Git branch reference + required: + - head_ref + - base_ref properties: head_ref: type: string @@ -2116,10 +2079,9 @@ paths: session_count: 1 artifacts: - provider: github - type: github_resource + type: pull data: id: 42 - type: pull_request archived_at: created_at: '2025-01-01T00:00:00Z' updated_at: '2025-01-01T01:00:00Z' @@ -2429,28 +2391,32 @@ paths: type: type: string enum: - - github_resource + - pull - branch - description: Discriminator for data shape + description: 'Type of artifact. Available Values: `pull`, + `branch`. + + ' data: oneOf: - type: object description: A GitHub resource (pull request, issue, etc.) + required: + - id properties: id: type: integer format: int64 description: GitHub resource ID - type: - type: string - description: Resource type (e.g., pull_request, - issue) global_id: type: string description: GraphQL global ID - type: object description: A Git branch reference + required: + - head_ref + - base_ref properties: head_ref: type: string @@ -2518,13 +2484,6 @@ paths: 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 @@ -2552,54 +2511,18 @@ paths: 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: + prompt: type: string description: Content of the triggering event - event_identifiers: - type: array - items: - type: string - description: Identifiers for tracking - resource_type: - type: string - description: Type of resource associated with this session - resource_id: - type: integer - format: int64 - description: Resource ID - resource_number: - type: integer - format: int32 - description: Resource number (e.g., PR number) - resource_global_id: - type: string - description: GraphQL global ID of the resource - resource_state: - type: string - description: State of the associated resource head_ref: type: string description: Head branch name 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 @@ -2626,10 +2549,9 @@ paths: session_count: 1 artifacts: - provider: github - type: github_resource + type: pull data: id: 42 - type: pull_request archived_at: created_at: '2025-01-01T00:00:00Z' updated_at: '2025-01-01T01:00:00Z' @@ -2647,9 +2569,10 @@ paths: created_at: '2025-01-01T00:00:00Z' updated_at: '2025-01-01T01:00:00Z' completed_at: '2025-01-01T01:00:00Z' - event_content: Fix the login button on the homepage + prompt: Fix the login button on the homepage head_ref: copilot/fix-1 base_ref: main + model: claude-sonnet-4.6 '400': description: Problems parsing request content: @@ -24124,6 +24047,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-exclude-secret-types" - "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" + - "$ref": "#/components/parameters/secret-scanning-alert-providers" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" @@ -48962,6 +48886,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-exclude-secret-types" - "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" + - "$ref": "#/components/parameters/secret-scanning-alert-providers" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" @@ -93075,6 +93000,13 @@ components: - string - 'null' description: The provider of the secret that was detected. + provider_slug: + type: + - string + - 'null' + description: The slug identifier for the provider of the secret that was + detected. Use this value for filtering by provider with the `providers` + or `exclude_providers` parameters. secret: type: string description: The secret that was detected. @@ -104619,6 +104551,13 @@ components: - string - 'null' description: The provider of the secret that was detected. + provider_slug: + type: + - string + - 'null' + description: The slug identifier for the provider of the secret that was + detected. Use this value for filtering by provider with the `providers` + or `exclude_providers` parameters. secret: type: string description: The secret that was detected. @@ -116882,6 +116821,12 @@ components: - string - 'null' description: The provider of the secret that was detected. + provider_slug: + type: + - string + - 'null' + description: The slug identifier for the provider of the secret that was + detected. validity: type: string description: The token status as of the latest validity check. @@ -248964,7 +248909,22 @@ components: secret-scanning-alert-exclude-providers: name: exclude_providers in: query - description: A comma-separated list of provider names to exclude from the results. + description: |- + A comma-separated list of provider slugs to exclude from the results. + Provider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`). + You can find the provider slug in the `provider_slug` field of each alert. + Cannot be combined with the `providers` parameter. + required: false + schema: + type: string + secret-scanning-alert-providers: + name: providers + in: query + description: |- + A comma-separated list of provider slugs to filter by. + Provider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`). + You can find the provider slug in the `provider_slug` field of each alert. + Cannot be combined with the `exclude_providers` parameter. required: false schema: type: string diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 228390d98f..e830cadc25 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -2487,26 +2487,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -2516,6 +2515,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -2592,10 +2595,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -2884,7 +2886,7 @@ }, "post": { "summary": "Create a task", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository\n", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository.\n", "tags": [ "agent-tasks" ], @@ -2926,33 +2928,21 @@ "schema": { "type": "object", "required": [ - "event_content" + "prompt" ], "properties": { - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID (optional, defaults to coding agent)" - }, - "problem_statement": { - "type": "string", - "description": "Additional prompting for the agent" - }, - "event_content": { + "prompt": { "type": "string", - "description": "User's written prompt" + "description": "The user's prompt for the agent" }, "model": { "type": "string", "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`" }, - "custom_agent": { - "type": "string", - "description": "Custom agent identifier" - }, "create_pull_request": { "type": "boolean", - "description": "Whether to create a PR" + "description": "Whether to create a PR.", + "default": false }, "base_ref": { "type": "string", @@ -2963,8 +2953,7 @@ "examples": { "default": { "value": { - "event_content": "Fix the login button on the homepage", - "create_pull_request": true, + "prompt": "Fix the login button on the homepage", "base_ref": "main" } } @@ -3103,26 +3092,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -3132,6 +3120,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -3598,26 +3590,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -3627,6 +3618,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -3720,15 +3715,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -3762,47 +3748,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -3811,20 +3760,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", @@ -3865,10 +3804,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -3893,9 +3831,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] } @@ -4418,26 +4357,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -4447,6 +4385,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -4521,10 +4463,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -4920,26 +4861,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -4949,6 +4889,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -5042,15 +4986,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -5084,47 +5019,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -5133,20 +5031,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", @@ -5187,10 +5075,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -5215,9 +5102,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] } @@ -240376,7 +240264,16 @@ { "name": "exclude_providers", "in": "query", - "description": "A comma-separated list of provider names to exclude from the results.", + "description": "A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `providers` parameter.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "providers", + "in": "query", + "description": "A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `exclude_providers` parameter.", "required": false, "schema": { "type": "string" @@ -240789,6 +240686,13 @@ ], "description": "The provider of the secret that was detected." }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -624600,7 +624504,16 @@ { "name": "exclude_providers", "in": "query", - "description": "A comma-separated list of provider names to exclude from the results.", + "description": "A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `providers` parameter.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "providers", + "in": "query", + "description": "A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `exclude_providers` parameter.", "required": false, "schema": { "type": "string" @@ -625020,6 +624933,13 @@ ], "description": "The provider of the secret that was detected." }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -626699,6 +626619,13 @@ ], "description": "The provider of the secret that was detected." }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -628361,6 +628288,13 @@ ], "description": "The provider of the secret that was detected." }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters." + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -1566391,6 +1566325,13 @@ ], "description": "The provider of the secret that was detected." }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected." + }, "validity": { "type": "string", "description": "The token status as of the latest validity check.", @@ -1569594,6 +1569535,13 @@ ], "description": "The provider of the secret that was detected." }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected." + }, "validity": { "type": "string", "description": "The token status as of the latest validity check.", @@ -1572629,6 +1572577,13 @@ ], "description": "The provider of the secret that was detected." }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the secret that was detected." + }, "validity": { "type": "string", "description": "The token status as of the latest validity check.", @@ -1576170,6 +1576125,13 @@ ], "description": "The provider of the secret that was detected." }, + "provider_slug": { + "type": [ + "string", + "null" + ], + "description": "The slug identifier for the provider of the se{"code":"deadline_exceeded","msg":"operation timed out"}