diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 08bc33918..2d6e8d0d9 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/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", @@ -892,10 +895,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1184,7 +1186,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" ], @@ -1226,33 +1228,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", @@ -1263,8 +1253,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" } } @@ -1403,26 +1392,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" @@ -1432,6 +1420,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1896,26 +1888,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" @@ -1925,6 +1916,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -2016,15 +2011,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" @@ -2058,47 +2044,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" @@ -2107,20 +2056,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", @@ -2161,10 +2100,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -2189,9 +2127,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" } ] } @@ -2714,26 +2653,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" @@ -2743,6 +2681,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -2815,10 +2757,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -3214,26 +3155,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" @@ -3243,6 +3183,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -3334,15 +3278,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" @@ -3376,47 +3311,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" @@ -3425,20 +3323,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", @@ -3479,10 +3367,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -3507,9 +3394,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" } ] } @@ -32764,6 +32652,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-providers" + }, { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, @@ -66651,6 +66542,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-providers" + }, { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, @@ -125827,6 +125721,11 @@ "description": "The provider of the secret that was detected.", "nullable": true }, + "provider_slug": { + "type": "string", + "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.", + "nullable": true + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -139772,6 +139671,11 @@ "description": "The provider of the secret that was detected.", "nullable": true }, + "provider_slug": { + "type": "string", + "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.", + "nullable": true + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -155988,6 +155892,11 @@ "description": "The provider of the secret that was detected.", "nullable": true }, + "provider_slug": { + "type": "string", + "description": "The slug identifier for the provider of the secret that was detected.", + "nullable": true + }, "validity": { "type": "string", "description": "The token status as of the latest validity check.", @@ -322081,7 +321990,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/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index a03d52c56..a6e55d166 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/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 @@ -624,10 +628,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' @@ -857,7 +860,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 @@ -889,18 +892,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: + prompt: type: string - description: Additional prompting for the agent - event_content: - 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 @@ -908,20 +904,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': @@ -1026,26 +1019,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 @@ -1407,28 +1405,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 @@ -1495,13 +1497,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 @@ -1529,54 +1524,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 @@ -1603,10 +1562,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' @@ -1624,9 +1582,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: @@ -2040,28 +1999,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 @@ -2112,10 +2075,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' @@ -2425,28 +2387,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 @@ -2513,13 +2479,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 @@ -2547,54 +2506,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 @@ -2621,10 +2544,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' @@ -2642,9 +2564,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: @@ -23940,6 +23863,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" @@ -48616,6 +48540,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" @@ -92473,6 +92398,12 @@ components: type: string description: The provider of the secret that was detected. nullable: true + provider_slug: + type: string + 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. + nullable: true secret: type: string description: The secret that was detected. @@ -103105,6 +103036,12 @@ components: type: string description: The provider of the secret that was detected. nullable: true + provider_slug: + type: string + 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. + nullable: true secret: type: string description: The secret that was detected. @@ -115536,6 +115473,11 @@ components: type: string description: The provider of the secret that was detected. nullable: true + provider_slug: + type: string + description: The slug identifier for the provider of the secret that was + detected. + nullable: true validity: type: string description: The token status as of the latest validity check. @@ -244493,7 +244435,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/api.github.com/api.github.com.2026-03-10.json b/descriptions/api.github.com/api.github.com.2026-03-10.json index e5d02017a..a10102330 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions/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", @@ -892,10 +895,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1184,7 +1186,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" ], @@ -1226,33 +1228,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", @@ -1263,8 +1253,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" } } @@ -1403,26 +1392,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" @@ -1432,6 +1420,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1896,26 +1888,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" @@ -1925,6 +1916,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -2016,15 +2011,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" @@ -2058,47 +2044,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" @@ -2107,20 +2056,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", @@ -2161,10 +2100,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -2189,9 +2127,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" } ] } @@ -2714,26 +2653,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" @@ -2743,6 +2681,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -2815,10 +2757,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -3214,26 +3155,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" @@ -3243,6 +3183,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -3334,15 +3278,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" @@ -3376,47 +3311,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" @@ -3425,20 +3323,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", @@ -3479,10 +3367,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -3507,9 +3394,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" } ] } @@ -32721,6 +32609,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-providers" + }, { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, @@ -66563,6 +66454,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-providers" + }, { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, @@ -125283,6 +125177,11 @@ "description": "The provider of the secret that was detected.", "nullable": true }, + "provider_slug": { + "type": "string", + "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.", + "nullable": true + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -139177,6 +139076,11 @@ "description": "The provider of the secret that was detected.", "nullable": true }, + "provider_slug": { + "type": "string", + "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.", + "nullable": true + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -155569,6 +155473,11 @@ "description": "The provider of the secret that was detected.", "nullable": true }, + "provider_slug": { + "type": "string", + "description": "The slug identifier for the provider of the secret that was detected.", + "nullable": true + }, "validity": { "type": "string", "description": "The token status as of the latest validity check.", @@ -321330,7 +321239,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/api.github.com/api.github.com.2026-03-10.yaml b/descriptions/api.github.com/api.github.com.2026-03-10.yaml index 64e273203..f44d94d45 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions/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 @@ -624,10 +628,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' @@ -857,7 +860,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 @@ -889,18 +892,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: + prompt: type: string - description: Additional prompting for the agent - event_content: - 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 @@ -908,20 +904,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': @@ -1026,26 +1019,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 @@ -1407,28 +1405,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 @@ -1495,13 +1497,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 @@ -1529,54 +1524,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 @@ -1603,10 +1562,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' @@ -1624,9 +1582,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: @@ -2040,28 +1999,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 @@ -2112,10 +2075,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' @@ -2425,28 +2387,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 @@ -2513,13 +2479,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 @@ -2547,54 +2506,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 @@ -2621,10 +2544,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' @@ -2642,9 +2564,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: @@ -23908,6 +23831,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" @@ -48542,6 +48466,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" @@ -92044,6 +91969,12 @@ components: type: string description: The provider of the secret that was detected. nullable: true + provider_slug: + type: string + 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. + nullable: true secret: type: string description: The secret that was detected. @@ -102635,6 +102566,12 @@ components: type: string description: The provider of the secret that was detected. nullable: true + provider_slug: + type: string + 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. + nullable: true secret: type: string description: The secret that was detected. @@ -115197,6 +115134,11 @@ components: type: string description: The provider of the secret that was detected. nullable: true + provider_slug: + type: string + description: The slug identifier for the provider of the secret that was + detected. + nullable: true validity: type: string description: The token status as of the latest validity check. @@ -243819,7 +243761,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/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 732b5dde2..2c7c9512e 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/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", @@ -892,10 +895,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1184,7 +1186,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" ], @@ -1226,33 +1228,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", @@ -1263,8 +1253,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" } } @@ -1403,26 +1392,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" @@ -1432,6 +1420,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1896,26 +1888,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" @@ -1925,6 +1916,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -2016,15 +2011,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" @@ -2058,47 +2044,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" @@ -2107,20 +2056,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", @@ -2161,10 +2100,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -2189,9 +2127,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" } ] } @@ -2714,26 +2653,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" @@ -2743,6 +2681,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -2815,10 +2757,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -3214,26 +3155,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" @@ -3243,6 +3183,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -3334,15 +3278,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" @@ -3376,47 +3311,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" @@ -3425,20 +3323,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", @@ -3479,10 +3367,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -3507,9 +3394,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" } ] } @@ -32956,6 +32844,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-providers" + }, { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, @@ -66953,6 +66844,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-providers" + }, { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, @@ -126810,6 +126704,11 @@ "description": "The provider of the secret that was detected.", "nullable": true }, + "provider_slug": { + "type": "string", + "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.", + "nullable": true + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -141082,6 +140981,11 @@ "description": "The provider of the secret that was detected.", "nullable": true }, + "provider_slug": { + "type": "string", + "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.", + "nullable": true + }, "secret": { "type": "string", "descr{"code":"deadline_exceeded","msg":"operation timed out"}